unleash-client - npm Package Compare versions

Comparing version 6.4.4 to 6.4.5

lib/details.json

@@ -1,1 +0,1 @@
-{ "name": "unleash-client-node", "version": "6.4.4", "sdkVersion": "unleash-client-node:6.4.4" }
+{ "name": "unleash-client-node", "version": "6.4.5", "sdkVersion": "unleash-client-node:6.4.5" }

lib/request.js

@@ -36,5 +36,2 @@ "use strict";
     }
-    if (connectionId) {
-        head['unleash-connection-id'] = connectionId;
-    }
     if (instanceId) {
@@ -57,2 +54,6 @@ head['UNLEASH-INSTANCEID'] = instanceId;
     }
+    // unleash-connection-id and unleash-sdk should not be overwritten
+    if (connectionId) {
+        head['unleash-connection-id'] = connectionId;
+    }
     return head;
@@ -59,0 +60,0 @@ };

package.json

 {
   "name": "unleash-client",
-  "version": "6.4.4",
+  "version": "6.4.5",
   "description": "Unleash Client for Node",
@@ -5,0 +5,0 @@ "license": "Apache-2.0",

README.md

@@ -5,8 +5,11 @@ # Unleash Client SDK for Node.js
 ![npm downloads](https://img.shields.io/npm/dm/unleash-client)
-[![Build Status](https://github.com/Unleash/unleash-client-node/workflows/Build/badge.svg)](https://github.com/Unleash/unleash-client-node/actions)
+[![Build Status](https://github.com/Unleash/unleash-client-node/actions/workflows/build-and-test.yaml/badge.svg)](https://github.com/Unleash/unleash-client-node/actions)
 [![Code Climate](https://codeclimate.com/github/Unleash/unleash-client-node/badges/gpa.svg)](https://codeclimate.com/github/Unleash/unleash-client-node)
 [![Coverage Status](https://coveralls.io/repos/github/Unleash/unleash-client-node/badge.svg?branch=main)](https://coveralls.io/github/Unleash/unleash-client-node?branch=main)
 
-The official Unleash client SDK for Node.js.
+Unleash is a private, secure, and scalable [feature management platform](https://www.getunleash.io/) built to reduce the risk of releasing new features and accelerate software development. This server-side Node.js SDK is designed to help you integrate with Unleash and evaluate feature flags inside your application.
 
+You can use this client with [Unleash Enterprise](https://www.getunleash.io/pricing?utm_source=readme&utm_medium=nodejs) or [Unleash Open Source](https://github.com/Unleash/unleash).
+
+
 ## Getting started
@@ -35,3 +38,3 @@
 Note that until the SDK has synchronized with the API, all features will evaluate to `false` unless
-you a [bootstrapped configuration](#bootstrap).
+you have a [bootstrapped configuration](#bootstrap).
 
@@ -123,3 +126,3 @@ ---
 
-// Unleash SDK has now fresh state from the unleash-api
+// The Unleash SDK now has a fresh state from the Unleash API
 const isEnabled = unleash.isEnabled('Demo');
@@ -148,4 +151,4 @@ ```
 👀 **Note**: In this example, we've wrapped the `isEnabled` call inside a `setInterval` function. In
-the event that all your app does is to start the SDK and check a feature status, this is will keep a
-node app running until the SDK has synchronized with the Unleash API. It is **not** required in
+the event that all your app does is start the SDK and check a feature status, this setup ensures that the
+node app keeps running until the SDK has synchronized with the Unleash API. It is **not** required in
 normal apps.
@@ -194,3 +197,3 @@
 
-To shut down the client (turn off the polling) you can simply call the destroy-method. This is
+To shut down the client (turn off the polling) you can simply call the `destroy` method. This is
 typically not required.
@@ -203,5 +206,5 @@
 
-### Built in activation strategies
+### Built-in activation strategies
 
-The client comes supports all built-in activation strategies provided by Unleash.
+The client supports all built-in activation strategies provided by Unleash.
 
@@ -242,3 +245,3 @@ Read more about
 - **customHeaders** - Provide a map(object) of custom headers to be sent to the unleash-server.
-- **customHeadersFunction** - Provide a function that return a Promise resolving as custom headers
+- **customHeadersFunction** - Provide a function that returns a Promise resolving as custom headers
   to be sent to unleash-server. When options are set, this will take precedence over `customHeaders`
@@ -248,11 +251,10 @@ option.
 - **repository** - Provide a custom repository implementation to manage the underlying data.
-- **httpOptions** - Provide custom http options such as `rejectUnauthorized` - be careful with these
+- **httpOptions** - Provide custom HTTP options such as `rejectUnauthorized` - be careful with these
   options as they may compromise your application security.
 - **namePrefix** - Only fetch feature toggles with the provided name prefix.
-- **tags** - Only fetch feature toggles tagged with the list of tags. E.g.:
-  `[{type: 'simple', value: 'proxy'}]`.
+- **tags** - Only fetch feature toggles tagged with the list of tags, such as: `[{type: 'simple', value: 'proxy'}]`.
 
 ## Custom strategies
 
-### 1. implement the custom strategy:
+### 1. Implement the custom strategy
 
@@ -272,3 +274,3 @@ ```js
 
-### 2. register your custom strategy:
+### 2. Register your custom strategy
 
@@ -293,9 +295,9 @@ ```js
 | synchronized | -                                | is emitted when the SDK has successfully synchronized with the Unleash API, or when it has been bootstrapped, and has all the latest feature toggle configuration available.                                                                 |
-| registered   | -                                | is emitted after the app has been registered at the api server                                                                                                                                                                               |
+| registered   | -                                | is emitted after the app has been registered at the API server                                                                                                                                                                               |
 | sent         | `object` data                    | key/value pair of delivered metrics                                                                                                                                                                                                          |
 | count        | `string` name, `boolean` enabled | is emitted when a feature is evaluated                                                                                                                                                                                                       |
 | warn         | `string` msg                     | is emitted on a warning                                                                                                                                                                                                                      |
-| error        | `Error` err                      | is emitted on a error                                                                                                                                                                                                                        |
+| error        | `Error` err                      | is emitted on an error                                                                                                                                                                                                                        |
 | unchanged    | -                                | is emitted each time the client gets new toggle state from server, but nothing has changed                                                                                                                                                   |
-| changed      | `object` data                    | is emitted each time the client gets new toggle state from server and changes has been made                                                                                                                                                  |
+| changed      | `object` data                    | is emitted each time the client gets new toggle state from server and changes have been made                                                                                                                                                  |
 | impression   | `object` data                    | is emitted for every user impression (isEnabled / getVariant)                                                                                                                                                                                |
@@ -323,4 +325,4 @@
 unleash.once('registered', () => {
-  // Do something after the client has registered with the server api.
-  // NB! It might not have received updated feature toggles yet.
+  // Do something after the client has registered with the server API.
+  // Note: it might not have received updated feature toggles yet.
 });
@@ -337,11 +339,11 @@
 
-(Available from v3.11.x)
+> Available from v3.11.x
 
 The Node.js SDK supports a bootstrap parameter, allowing you to load the initial feature toggle
 configuration from somewhere else than the Unleash API. The bootstrap `data` can be provided as an
-argument directly to the SDK, as a `filePath` to load or as a `url` to fetch the content from.
+argument directly to the SDK, as a `filePath` to load, or as a `url` to fetch the content from.
 Bootstrap is a convenient way to increase resilience, where the SDK can still load fresh toggle
 configuration from the bootstrap location, even if the Unleash API should be unavailable at startup.
 
-**1. Bootstrap with data passed as an argument**
+### 1. Bootstrap with data passed as an argument
 
@@ -370,3 +372,3 @@ ```js
 
-**2. Bootstrap via a URL**
+### 2. Bootstrap via a URL
 
@@ -387,3 +389,3 @@ ```js
 
-**3. Bootstrap from a File**
+### 3. Bootstrap from a file
 
@@ -423,7 +425,7 @@ ```js
 
-## Custom Store Provider
+## Custom store provider
 
 (Available from v3.11.x)
 
-By default this SDK will use a store provider that writes a backup of the feature toggle
+By default, this SDK will use a store provider that writes a backup of the feature toggle
 configuration to a **file on disk**. This happens every time it receives updated configuration from
@@ -433,3 +435,3 @@ the Unleash API. You can swap out the store provider with either the provided in-memory store
 
-**1. Use InMemStorageProvider**
+### 1. Use `InMemStorageProvider`
 
@@ -447,3 +449,3 @@ ```js
 
-**2. Custom Store Provider backed by redis**
+### 2. Custom store provider backed by Redis
 
@@ -481,8 +483,8 @@ ```js
 
-You can manage the underlying data layer yourself if you want to. This enables you to use unleash
-offline, from a browser environment or implement your own caching layer. See
+You can manage the underlying data layer yourself if you want to. This enables you to use Unleash
+offline, from a browser environment, or by implement your own caching layer. See
 [example](examples/custom_repository.js).
 
 Unleash depends on a `ready` event of the repository you pass in. Be sure that you emit the event
-**after** you've initialized unleash.
+**after** you've initialized Unleash.
 
@@ -492,3 +494,3 @@ ## Usage with HTTP and HTTPS proxies
 You can connect to the Unleash API through the corporate proxy by setting one of the environment
-variables: `HTTP_PROXY` or `HTTPS_PROXY`
+variables: `HTTP_PROXY` or `HTTPS_PROXY`.
 
@@ -495,0 +497,0 @@ ## Design philosophy

No alert changes

Improved metrics

Total package byte prevSize

245919

increased by0.24%

Lines of code

3117

increased by0.03%

Number of lines in readme file

482

increased by0.42%

No dependency changes