Bucket

What is Bucket about?

Bucket provides a suite of TypeScript/JavaScript SDKs that let developers control feature flag rollout across client‑side frameworks (React, Vue, plain browser) and server‑side environments (Node.js, Cloudflare Workers). It also includes a command‑line interface for generating type definitions and integrates with the OpenFeature standard.

How to use Bucket?

1. Install the desired package (example for the React SDK):

   npm install @bucketco/react-sdk
   # or using yarn
   yarn add @bucketco/react-sdk
   

2. Initialize the client with your Bucket API key:

   import { BucketProvider } from '@bucketco/react-sdk';
   
   const App = () => (
     <BucketProvider apiKey="YOUR_API_KEY">
       {/* Your app */}
     </BucketProvider>
   );
   

3. Evaluate flags in components:

   const { isEnabled } = useBucket();
   const showNewFeature = isEnabled('new-feature-flag');
   

4. For Node.js:

   npm install @bucketco/node-sdk
   

   const { BucketClient } = require('@bucketco/node-sdk');
   const client = new BucketClient({ apiKey: process.env.BUCKET_API_KEY });
   const isEnabled = await client.isEnabled('server-flag');
   

5. CLI usage (generate type definitions):

   npx @bucketco/cli generate-types --output ./types
   

Key features of Bucket

• Multi‑platform SDKs: React, Vue (beta), plain browser, Node.js, Cloudflare Workers.
• TypeScript‑first: Full type definitions out‑of‑the‑box.
• OpenFeature providers for both browser and Node.js environments.
• CLI tool to fetch schema and generate TypeScript types automatically.
• Versioned publishing via GitHub Actions; each package follows independent versioning.

Use cases of Bucket

• Gradual rollout of new UI components in a React application.
• A/B testing features across different customer segments.
• Turning on/off server‑side logic in a Node.js API without redeploying.
• Managing feature flags for edge functions like Cloudflare Workers.
• Centralizing flag definitions and syncing them to multiple front‑end frameworks.

FAQ from Bucket

Q: Do I need a separate package for each framework? A: Yes, each framework (React, Vue, browser, Node) has its own optimized SDK, but they share the same underlying flag definitions.

Q: How are flags updated in real time? A: SDKs maintain a WebSocket/Long‑poll connection to Bucket’s backend, delivering updates instantly to the client.

Q: Can I use Bucket with existing OpenFeature implementations? A: Absolutely. Bucket provides OpenFeature providers for both browser and Node environments, allowing seamless integration.

Q: Is there a free tier? A: Bucket offers a free tier for small projects; consult the Bucket website for current limits.

Q: How do I publish my own changes? A: Follow the repository’s development workflow: create a branch, run yarn run version, then open a PR. The CI pipeline publishes the package on merge to main.

Bucket

Feature flags for SaaS that run on TypeScript. Learn more and get started

React SDK

Client side React SDK

Read the docs

Vue SDK (beta)

Client side Vue SDK

Read the docs

Browser SDK

Browser SDK for use in non-React web applications

Read the docs

Node.js SDK

Node.js SDK for use on the server side. Use this for Cloudflare Workers as well.

Read the docs

Bucket CLI

CLI to interact with Bucket and generate types

Read the docs

OpenFeature Browser Provider

Use Bucket with OpenFeature in the browser through the Bucket OpenFeature Browser Provider

Read the docs

OpenFeature Node.js Provider

Use the Bucket with OpenFeature on the server in Node.js through the Bucket OpenFeature Node.js Provider

Read the docs

Development

Versioning

1. Create a new branch locally
2. Run yarn run version
3. Push and PR

Publishing

The Github Action will automatically publish any versioned packages when merging to main