nathanfriemel/js-sdk

JavaScript frontend SDK for ConfigCat, a feature-flag and remote-config service with unlimited users and a free plan.

ConfigCat SDK for JavaScript frontend applications

https://configcat.com

ConfigCat SDK for JavaScript 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.

Getting Started

1. Install and import package:

via NPM package:

npm i configcat-js

import * as configcat from "configcat-js";

via CDN:

<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/[email protected]/dist/configcat.min.js"></script>

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

3. Create a ConfigCat client instance:

var 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.getValue("isMyAwesomeFeatureEnabled", false, (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 the getValue() function.

Read more about Targeting here.

configCatClient.getValue("isMyAwesomeFeatureEnabled", false, (value) => {
    if(value) {
        do_the_new_thing();
    } else {
        do_the_old_thing();
    }},
    { identifier : "#USER-IDENTIFIER#" }
);

Sample/Demo apps

• Angular 2+
• React
• Pure HTML + JS

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.

Support

If you need help how to use this SDK feel free to to contact the ConfigCat Staff on https://configcat.com. We're happy to help.

Contributing

Contributions are welcome.

About ConfigCat

• Official ConfigCat SDK's for other platforms
• Documentation
• Blog