JavaScript Shell
eli-darkly Merge pull request #103 from jbatchelor-atlassian/master
Improves error message when calling all_flags() without a user object
Latest commit 17ace62 Jul 3, 2018
Permalink
Failed to load latest commit information.
.circleci prepare 5.0.0 release (#91) May 11, 2018
scripts Add release script Jul 21, 2017
test prepare 5.1.0 release (#101) Jun 26, 2018
utils prepare 5.0.0 release (#91) May 11, 2018
.gitignore prepare 4.0.4 release (#87) Apr 17, 2018
.hound.yml specify node version for circle build Apr 15, 2016
CHANGELOG.md prepare 5.1.0 release (#101) Jun 26, 2018
CONTRIBUTING.md fix 1.0 documentation link Jan 23, 2018
LICENSE.txt Copyright and changelog Aug 9, 2016
README.md prepare 5.1.0 release (#101) Jun 26, 2018
configuration.js prepare 5.0.0 release (#91) May 11, 2018
errors.js prepare 5.1.0 release (#101) Jun 26, 2018
evaluate_flag.js prepare 5.0.0 release (#91) May 11, 2018
event_processor.js prepare 5.1.0 release (#101) Jun 26, 2018
event_summarizer.js prepare 5.0.1 release (#93) May 31, 2018
eventsource.js prepare 5.1.0 release (#101) Jun 26, 2018
feature_store.js prepare 5.0.0 release (#91) May 11, 2018
feature_store_event_wrapper.js prepare 4.0.1 release (#83) Mar 9, 2018
index.d.ts prepare 5.1.0 release (#101) Jun 26, 2018
index.js Improves error message when calling all_flags() without a user object Jul 2, 2018
messages.js prepare 5.1.0 release (#101) Jun 26, 2018
operators.js prepare 5.0.0 release (#91) May 11, 2018
package-lock.json prepare 5.0.2 release (#98) Jun 15, 2018
package.json prepare 5.1.0 release (#101) Jun 26, 2018
polling.js prepare 5.1.0 release (#101) Jun 26, 2018
redis_feature_store.js prepare 5.0.0 release (#91) May 11, 2018
requestor.js prepare 5.0.0 release (#91) May 11, 2018
streaming.js prepare 5.0.0 release (#91) May 11, 2018
tsconfig.json update TypeScript typedefs Jul 11, 2017
user_filter.js prepare 5.0.0 release (#91) May 11, 2018
versioned_data_kind.js prepare 4.0.0 release (#80) Feb 21, 2018

README.md

LaunchDarkly SDK for Node.js

Circle CI

Supported Node versions

This version of the LaunchDarkly SDK has been tested with Node versions 6.14 and up.

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")
    

HTTPS proxy

Node provides built-in support for the use of an HTTPS proxy. You can use NPM to configure Node to proxy all network requests through the URL provided.

npm config set https-proxy https://web-proxy.domain.com:8080

If your proxy requires authentication then you can prefix the URN with your login information:

npm config set https-proxy http://user:pass@web-proxy.domain.com:8080

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.variation("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.

Testing

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.

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

  • LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
    • Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
    • Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
    • Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
    • Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan). Disable parts of your application to facilitate maintenance, without taking everything offline.
  • LaunchDarkly provides feature flag SDKs for
  • Explore LaunchDarkly