@configdirector/openfeature-server-provider 1.3.0 → 1.5.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/README.md
CHANGED
|
@@ -1,13 +1,41 @@
|
|
|
1
1
|
# ConfigDirector OpenFeature Node.js Provider
|
|
2
2
|
|
|
3
|
-
|
|
3
|
+
[![npm][npm-badge]][npm]
|
|
4
|
+
|
|
5
|
+
[OpenFeature](https://openfeature.dev) Node.js provider SDK for [ConfigDirector](https://www.configdirector.com), remote config and feature flags with typed values, JSON Schema validation, and safe renames of live flags. Start free, no card required.
|
|
6
|
+
|
|
7
|
+
## Install
|
|
8
|
+
|
|
9
|
+
```bash
|
|
10
|
+
npm install --save @configdirector/openfeature-server-provider @openfeature/server-sdk
|
|
11
|
+
```
|
|
12
|
+
|
|
13
|
+
## Retrieve a value
|
|
14
|
+
|
|
15
|
+
```ts
|
|
16
|
+
import { OpenFeature } from "@openfeature/server-sdk";
|
|
17
|
+
import { ConfigDirectorProvider } from "@configdirector/openfeature-server-provider";
|
|
18
|
+
|
|
19
|
+
// The server SDK key is a secret. Do not commit it to your source code.
|
|
20
|
+
await OpenFeature.setProviderAndWait(new ConfigDirectorProvider("YOUR-SERVER-SDK-KEY"));
|
|
21
|
+
const client = OpenFeature.getClient();
|
|
22
|
+
|
|
23
|
+
const newCheckout = await client.getBooleanValue("new-checkout", false);
|
|
24
|
+
```
|
|
25
|
+
|
|
26
|
+
Full details are in the [official documentation](https://docs.configdirector.com/sdks/server/openfeature-node).
|
|
4
27
|
|
|
5
28
|
## Documentation
|
|
6
29
|
|
|
7
|
-
Refer to the [official documentation for the OpenFeature Node.js
|
|
30
|
+
Refer to the [official documentation for the OpenFeature Node.js provider](https://docs.configdirector.com/sdks/server/openfeature-node).
|
|
8
31
|
|
|
9
32
|
There is also [a quickstart guide for ConfigDirector and any of our SDKs](https://docs.configdirector.com/getting-started/quickstart).
|
|
10
33
|
|
|
11
34
|
## Getting Help
|
|
12
35
|
|
|
13
|
-
|
|
36
|
+
- [Ask a question in Discussions](https://github.com/orgs/ConfigDirector/discussions)
|
|
37
|
+
- [Contact support](https://www.configdirector.com/support)
|
|
38
|
+
|
|
39
|
+
[//]: # "links"
|
|
40
|
+
[npm-badge]: https://img.shields.io/npm/v/@configdirector/openfeature-server-provider.svg
|
|
41
|
+
[npm]: https://www.npmjs.com/package/@configdirector/openfeature-server-provider
|