You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Nov 18, 2024. It is now read-only.
Copy file name to clipboardExpand all lines: CHANGELOG.md
+4Lines changed: 4 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,6 +2,10 @@
2
2
3
3
All notable changes to the LaunchDarkly Node.js SDK Consul integration will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org).
4
4
5
+
## [1.0.1] - 2019-05-14
6
+
### Changed:
7
+
- Corresponding to the SDK package name change from `ldclient-node` to `launchdarkly-node-server-sdk`, this package is now called `launchdarkly-node-server-sdk-consul`. The functionality of the package, including the namespaces and class names, has not changed.
This library provides a Consul-backed persistence mechanism (feature store) for the [LaunchDarkly Node.js SDK](https://github.com/launchdarkly/node-client), replacing the default in-memory feature store. It uses the [consul](https://www.npmjs.com/package/consul) package.
5
+
This library provides a Consul-backed persistence mechanism (feature store) for the [LaunchDarkly server-side Node.js SDK](https://github.com/launchdarkly/node-server-sdk), replacing the default in-memory feature store. It uses the [consul](https://www.npmjs.com/package/consul) package.
6
6
7
-
The minimum version of the LaunchDarkly Node.js SDK for use with this library is 5.7.0.
7
+
The minimum version of the LaunchDarkly Node.js SDK for use with this library is 5.8.1.
8
8
9
9
For more information, see also: [Using a persistent feature store](https://docs.launchdarkly.com/v2.0/docs/using-a-persistent-feature-store).
10
10
11
-
Quick setup
12
-
-----------
11
+
## Quick setup
13
12
14
13
This assumes that you have already installed the LaunchDarkly Node.js SDK.
var ConsulFeatureStore = require('ldclient-node-consul-store');
21
+
var ConsulFeatureStore = require('launchdarkly-node-server-sdk-consul');
23
22
24
23
3. When configuring your SDK client, add the Consul feature store:
25
24
@@ -36,36 +35,23 @@ This assumes that you have already installed the LaunchDarkly Node.js SDK.
36
35
37
36
var store = ConsulFeatureStore({ consulOptions: { host: 'your-consul-host' }, prefix: 'env1' });
38
37
39
-
Caching behavior
40
-
----------------
38
+
## Caching behavior
41
39
42
40
To reduce traffic to Consul, there is an optional in-memory cache that retains the last known data for a configurable amount of time. This is on by default; to turn it off (and guarantee that the latest feature flag data will always be retrieved from Consul for every flag evaluation), configure the store as follows:
43
41
44
42
var store = ConsulFeatureStore('YOUR TABLE NAME', { cacheTTL: 0 });
45
43
46
-
About LaunchDarkly
47
-
------------------
44
+
## About LaunchDarkly
48
45
49
46
* 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:
50
47
* 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.
51
48
* 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?).
52
49
* 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.
53
50
* 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 a wide variety of languages and technologies. Check out [our documentation](https://docs.launchdarkly.com/docs) for a complete list.
66
52
* Explore LaunchDarkly
67
-
*[launchdarkly.com](http://www.launchdarkly.com/"LaunchDarkly Main Website") for more information
68
-
*[docs.launchdarkly.com](http://docs.launchdarkly.com/"LaunchDarkly Documentation") for our documentation and SDKs
69
-
*[apidocs.launchdarkly.com](http://apidocs.launchdarkly.com/"LaunchDarkly API Documentation") for our API documentation
70
-
*[blog.launchdarkly.com](http://blog.launchdarkly.com/"LaunchDarkly Blog Documentation") for the latest product updates
53
+
*[launchdarkly.com](https://www.launchdarkly.com/"LaunchDarkly Main Website") for more information
54
+
*[docs.launchdarkly.com](https://docs.launchdarkly.com/"LaunchDarkly Documentation") for our documentation and SDK reference guides
55
+
*[apidocs.launchdarkly.com](https://apidocs.launchdarkly.com/"LaunchDarkly API Documentation") for our API documentation
56
+
*[blog.launchdarkly.com](https://blog.launchdarkly.com/"LaunchDarkly Blog Documentation") for the latest product updates
71
57
*[Feature Flagging Guide](https://github.com/launchdarkly/featureflags/"Feature Flagging Guide") for best practices and strategies
0 commit comments