/node-client

LaunchDarkly SDK for Node

Primary LanguageJavaScriptOtherNOASSERTION

LaunchDarkly SDK for Node.js

Quick setup

  1. Install the Node.js SDK with npm

     npm install ldclient-node --save

  2. Require the LaunchDarkly client:

     var LaunchDarkly = require('ldclient-node');

  3. Create a new LDClient with your SDK key:

     var ld_client = LaunchDarkly.init("YOUR SDK KEY")

Your first feature flag

  1. Create a new feature flag on your dashboard

  2. In your application code, use the feature's key to check whether the flag is on for each user:

     ld_client.once('ready', function() {
   ld_client.toggle("your.flag.key", {"key" : "user@test.com"}, false, function(err, show_feature) {
     if (show_feature) {
         # application code to show the feature
     }
     else {
         # the code to run if the feature is off 
     }
   });
 });

Learn more

Check out our documentation for in-depth instructions on configuring and using LaunchDarkly. You can also head straight to the complete reference guide for this SDK.

Contributing

We encourage pull-requests and other contributions from the community. We've also published an SDK contributor's guide that provides a detailed explanation of how our SDKs work.

About LaunchDarkly