GrowthBook

Table of contents

1. Installation
2. Usage
   1. createGrowthbook

Installation

@growthbook/growthbook is an optional dependency. In order to enable it you need to install it by giving it an alias as growthbook:

npm i growthbook@npm:@growthbook/growthbook

It will connect to growthbook automatically if a growthbook clientKey is provided.

eg:

GROWTHBOOK_CLIENT_KEY={url} node app.js

Usage

//config/config.js

module.exports = {
  growthbook: {
    clientKey: '1234',
    // The duration that the request will be blocked until features are loaded
    timeout: 10
  }
};

createGrowthbook

You can call createGrowthbook to retrieve a new growthbook instance. You can use a generic typing, so you will have autocompletion when using the isOn method.

IMPORTANT: If you call this method you are responsible for calling .destroy() when finished

const { createGrowthbook } = require('@workablehr/orka');

const gb = createGrowthbook<{featureA: boolean}>();
await gb.loadFeatures();
if (gb.isOn('featureA')) {
  // Do stuff...
}
gb.destroy();