https://github.com/unlaunch/nodejs-sdk
Unlaunch SDK for Node.js
https://github.com/unlaunch/nodejs-sdk
Last synced: 6 months ago
JSON representation
Unlaunch SDK for Node.js
- Host: GitHub
- URL: https://github.com/unlaunch/nodejs-sdk
- Owner: unlaunch
- Created: 2020-12-27T21:27:49.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-09-21T06:38:12.000Z (almost 5 years ago)
- Last Synced: 2025-09-13T02:56:37.046Z (10 months ago)
- Language: JavaScript
- Size: 132 KB
- Stars: 4
- Watchers: 5
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Unlaunch Node.js SDK
| master | development |
|---------------------------------------------------------------------------------------------------------------------|----------------------------------------------------------------------------------------------------------------------------|
| [](https://app.travis-ci.com/unlaunch/nodejs-sdk) |[](https://app.travis-ci.com/unlaunch/nodejs-sdk) |
## Overview
The Unlaunch Node.js SDK provides a Node.js API to access Unlaunch feature flags and other features. Using this SDK, you can easily build Javascript applications that can evaluate feature flags, dynamic configurations, and more.
### Important Links
- To create feature flags to use with Node.js SDK, login to your Unlaunch Console at [https://app.unlaunch.io](https://app.unlaunch.io)
- [Official Guide](https://docs.unlaunch.io/docs/sdks/nodejs-sdk)
- [Documentation](https://github.com/unlaunch/nodejs-sdk#section-documentation)
- [Example Project](https://github.com/unlaunch/hello-node)
## Getting Started
First install the Node SDK using your package manager.
```
npm install --save unlaunch-node-sdk
```
Next, require the UnlaunchFactory into your application.
```javascript
const {UnlaunchFactory} = require('unlaunch-node-sdk');
```
Here is a simple example showing how to use the this SDK in your Node.js application.
```javascript
let factory = UnlaunchFactory({
core:{
sdkKey:'INSERT_YOUR_SDK_KEY'
},
intervals: {
// fetch feature updates each 30 sec
pollingInterval: 30,
// publish metrics each 120 sec
metricsFlushInterval: 120,
// flush events every 60 seconds after the first flush
eventsFlushInterval: 60,
// http connection timeout
httpConnectionTimeout: 10
}
});
const client = factory.client();
client.once('READY',()=> {
const variation = client.variation('flag-1','user123');
console.log("variation served: "+ variation)
});
```
## Build Instructions
To run all tests
```shell
npm test
```
## How to Publish
Create a new tag on GitHub in the following format vx.y.z e.g. v0.0.1
## Submitting issues
If you run into any problems, bugs, or have any questions or feedback, please report them using the [issues feature](https://github.com/unlaunch/nodejs-sdk/issues). We'll respond to all issues usually within 24 to 48 hours.
## License
Licensed under the Apache License, Version 2.0. See: [Apache License](LICENSE.md).
## About Unlaunch
Unlaunch is a Feature Release Platform for engineering teams. Our mission is allow engineering teams of all
sizes to release features safely and quickly to delight their customers. To learn more about Unlaunch, please visit
[unlaunch.io](https://unlaunch.io). You can sign up to get started for free at [https://app.unlaunch.io/signup](https://app.unlaunch.io/signup).