Configcat-client NPM

ConfigCat SDK for Node.js and SSR

ConfigCat SDK for Node.js and SSR (Server-Side Rendering) provides easy integration for your application to ConfigCat.

ConfigCat is a feature flag and configuration management service that lets you separate releases from deployments. You can turn your features ON/OFF using ConfigCat Management Console even after they are deployed. ConfigCat lets you target specific groups of users based on region, email or any other custom user attribute.

ConfigCat is a hosted feature flag service. Manage feature toggles across frontend, backend, mobile, desktop apps. Alternative to LaunchDarkly. Management app + feature flag SDKs.

License \

Getting Started

1. Install and import package:

via NPM package:

npm i configcat-node

const configcat = require("configcat-node");

In case of SSR (Server-Side Rendering) Universal applications:

import * as configcat from "configcat-node";

2. Go to Connect your application tab to get your API Key:

API-KEY

3. Create a ConfigCat client instance:

let configCatClient = configcat.createClient("#YOUR-API-KEY#");

We strongly recommend using the ConfigCat Client as a Singleton object in your application.

4. Get your setting value:

configCatClient.getValueAsync("isMyAwesomeFeatureEnabled", false)
.then((value) => {
    if(value) {
        do_the_new_thing();
    } else {
        do_the_old_thing();
    }
});

Getting user specific setting values with Targeting

Using this feature, you will be able to get different setting values for different users in your application by passing a User Object to getValueAsync().

Sample/Demo app

Sample Console App

Polling Modes

The ConfigCat SDK supports 3 different polling mechanisms to acquire the setting values from ConfigCat. After latest setting values are downloaded, they are stored in the internal cache then all requests are served from there. Read more about Polling Modes and how to use them at ConfigCat Docs.