Name: node-client
Owner: Clever
Description: LaunchDarkly SDK for Node
Forked from: launchdarkly/node-client
Created: 2017-05-16 21:26:48.0
Updated: 2017-05-16 21:26:50.0
Pushed: 2017-05-16 22:19:24.0
Homepage: null
Size: 176
Language: JavaScript
GitHub Committers
User | Most Recent Commit | # Commits |
---|
Other Committers
User | Most Recent Commit | # Commits |
---|
Install the Node.js SDK with npm
npm install ldclient-node --save
Require the LaunchDarkly client:
var LaunchDarkly = require('ldclient-node');
Create a new LDClient with your SDK key:
var ld_client = LaunchDarkly.init("YOUR SDK KEY")
Create a new feature flag on your dashboard
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
}
});
});
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.
We run integration tests for all our SDKs using a centralized test harness. This approach gives us the ability to test for consistency across SDKs, as well as test networking behavior in a long-running application. These tests cover each method in the SDK, and verify that event sending, flag evaluation, stream reconnection, and other aspects of the SDK all behave correctly.
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.