@flaggr/sdk
v0.1.0
Published
Flaggr feature flag SDK for TypeScript — type-safe evaluation with pluggable OpenTelemetry instrumentation
Maintainers
Readme
@flaggr/sdk
TypeScript SDK for Flaggr — type-safe feature flag evaluation with React hooks and OpenTelemetry instrumentation.
Installation
npm install @flaggr/sdkQuick Start
import { createFlaggr } from '@flaggr/sdk'
const client = createFlaggr({
serviceId: 'web-app',
apiKey: 'flg_your_token',
})
const isEnabled = await client.getBooleanValue('checkout-v2', false)React
import { FlaggrProvider, useBooleanFlag } from '@flaggr/sdk/react'
function App() {
return (
<FlaggrProvider config={{ serviceId: 'web-app', apiKey: 'flg_xxx' }}>
<Checkout />
</FlaggrProvider>
)
}
function Checkout() {
const useNewFlow = useBooleanFlag('checkout-v2', false)
return useNewFlow ? <CheckoutV2 /> : <CheckoutClassic />
}OpenTelemetry
import { createFlaggr } from '@flaggr/sdk'
import { otelPlugin } from '@flaggr/sdk/otel'
const client = createFlaggr({
serviceId: 'web-app',
apiKey: 'flg_xxx',
plugins: [otelPlugin()],
})Exports
| Entry Point | Description |
|-------------|-------------|
| @flaggr/sdk | Core client and evaluation methods |
| @flaggr/sdk/react | React hooks and provider |
| @flaggr/sdk/otel | OpenTelemetry instrumentation plugin |
