@roninjin10/typesafe-growthbook
v0.0.1
Published
A light wrapper around growthbook based on zod
Downloads
4
Readme
typesafe-growthbook
A light easy to configure typesafe wrapper around @growthbook/react providing runtime validation and typesafety with zod
Getting started
- Install @roninjin10/typesafe-env
npm i @roninjin10/typesafe-env
- Install peer dependencies
npm i @growthbook/growthbook-react zod react
- Specify your flags and initialize Growthbook
import { flag, TypesafeGrowthbook } from '@roninjin10/typesafe-growthbook'
const flags = {
myBoolFlag: flag.bool,
myStringFLag: flag.string,
myUrlFlag: flag.url,
myNumberFlag: flag.number,
}
export const growthbook = new TypesafeGrowthbook(flags)
- Initialize the react api if you are using react
export const { Provider, useFeature, IfFeatureEnabled, FeatureString } =
initGrowthbookReact(growthbook)
You now have a version of growthbook that has full typesafety! The zod validators will validate your feature flags and throw an error if they are misconfigured.
All react hooks and growthbook methods will infer flag ids and value types from the flag object you provided!
Flag validators
Flag validators are provided for all types of flags supported by growthbook.
- flag.bool
- flag.url
- flag.string
- flag.number
- flag.stringArray
- flag.numberArray
To make a JSON feature flag use z.object from zod
import {z} from 'zod'
const flags = {
myJsonFlag: z.object({
...
})
}
Creating a default fallback
Sometimes we don't want to crash the entire app when flag validation fails. In this case you can create a fallback value.
import { flag } from '@roninjin10/typesafe-growthbook'
const flags = {
backedUrl: flag.url().catch('http://default-url-fallback'),
}
Creating an optional value
We can also create optional values with zod if the flag is optional
import { flag } from '@roninjin10/typesafe-growthbook'
const flags = {
backedUrl: flag.bool().optional(),
}
What's changed from growthbook
TypesafeGrowthbook is a typesafe wrapper around growthbook with no changes to the Growthbook API. It simply adds type safety.
Refer to the growthbook docs for more information on their api
Contributing
All of @roninjin10 is open to contributions! To get started follow these steps
- Clone the repo
- Install pnpm
npm install -g pnpm
- Install node modules
pnpm install
- Cd to typesafe-env
cd packages/typesafe-env
- Run the tests
pnpm test
- Run the build
pnpm build
- Optionally spin up the example app
nx dev
ordocker-compose up
- Run only typesafe growthbook tests
nx test @roninjin10/typesafe-gorwthbook