bullet-train-nodejs

v1.0.6

Bullet Train lets you manage features flags and remote config across web, mobile and server side applications. Deliver true Continuous Integration. Get builds out faster. Control who has access to new features. For more information about how to use this package see README

Latest version published 4 years ago

License: BSD-3-Clause

NPM

GitHub

Package Health Score

48 / 100

security
No known security issues
popularity
Limited
maintenance
Inactive
community
Sustainable

Explore Similar Packages

Security

No known security issues

All security vulnerabilities belong to production dependencies of direct and indirect packages.

Security and license risk for significant versions

All Versions

Version			Vulnerabilities	License Risk
1.0.6	\|	10/2020	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.2	\|	06/2018	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.1.1	\|	06/2018	0 C 0 H 0 M 0 L	0 H 0 M 0 L
0.0.9	\|	06/2018	0 C 0 H 0 M 0 L	0 H 0 M 0 L

License

BSD-3-Clause

Security Policy

Is your project affected by vulnerabilities?

Scan your projects for vulnerabilities. Fix quickly with automated fixes. Get started with Snyk for free.

Get started free

Popularity

Limited

Weekly Downloads (1)

GitHub Stars: 26
Forks: 22
Contributors: 20

Direct Usage Popularity

The npm package bullet-train-nodejs receives a total of 1 downloads a week. As such, we scored bullet-train-nodejs popularity level to be Limited.

Based on project statistics from the GitHub repository for the npm package bullet-train-nodejs, we found that it has been starred 26 times.

Downloads are calculated as moving averages for a period of the last 12 months, excluding weekends and known missing data points.

Community

Sustainable

Readme.md: Yes
Contributing.md: Yes
Code of Conduct: No
Contributors: 20
Funding: No

With more than 10 contributors for the bullet-train-nodejs repository, this is possibly a sign for a growing and inviting community.

We found a way for you to contribute to the project! Looks like bullet-train-nodejs is missing a Code of Conduct.

Embed Package Health Score Badge

Maintenance

Inactive

deprecated

Commit Frequency

Open Issues: 3
Open PR: 3
Last Release: 4 years ago
Last Commit: 3 months ago

Further analysis of the maintenance status of bullet-train-nodejs based on released npm versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

An important project maintenance signal to consider for bullet-train-nodejs is that it hasn't seen any new versions released to npm in the past 12 months, and could be considered as a discontinued project, or that which receives low attention from its maintainers.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Keep your project healthy

Check your package.json

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Node.js Compatibility: not defined

Age: 6 years
Dependencies: 1 Direct
Versions: 20
Install Size: 53.9 kB
Dist-tags: 2
# of Files: 22
Maintainers: 3
TS Typings: No

bullet-train-nodejs has more than a single and default latest tag published for the npm package. This means, there may be other tags available for this package, such as next to indicate future releases, or stable to indicate stable releases.

Readme

Bullet Train Client

The SDK clients for NodeJS https://bullet-train.io/. Bullet Train allows you to manage feature flags and remote config across multiple projects, environments and organisations.

Getting Started

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See running in production for notes on how to deploy the project on a live system.

Installing

VIA npm

npm i bullet-train-nodejs --save

Usage

Retrieving feature flags for your project

For full documentation visit https://docs.bullet-train.io

var bulletTrain = require("bullet-train-nodejs");

bulletTrain.init({
    environmentID:""
});

bulletTrain.hasFeature("header", '')
.then((featureEnabled) =&gt; {
    if (featureEnabled) {
        //Show my awesome cool new feature to this one user
    }
});
bulletTrain.hasFeature("header")
.then((featureEnabled) =&gt; {
    if (featureEnabled) {
        //Show my awesome cool new feature to the world
    }
});

bulletTrain.getValue("header", '')
.then((value) =&gt; {
    //Show some unique value to this user
});

bulletTrain.getValue("header")
.then((value) =&gt; {
    //Show a value to the world
});

Available Options

Property	Description	Required	Default Value
`environmentID`	Defines which project environment you wish to get flags for. example ACME Project - Staging.	YES	null
`onError`	Callback function on failure to retrieve flags. `(error)=>{...}`	NO	null
`defaultFlags`	Defines the default flags if there are any	NO	null
`api`	Use this property to define where you're getting feature flags from, e.g. if you're self hosting.	NO	https://bullet-train-api.dokku1.solidstategroup.com/api/v1/

Available Functions

Property	Description
`init`	Initialise the sdk against a particular environment
`hasFeature(key)`	Get the value of a particular feature e.g. `bulletTrain.hasFeature("powerUserFeature") // true`
`hasFeature(key, userId)`	Get the value of a particular feature for a user e.g. `bulletTrain.hasFeature("powerUserFeature", 1234) // true`
`getValue(key)`	Get the value of a particular feature e.g. `bulletTrain.getValue("font_size") // 10`
`getValue(key, userId)`	Get the value of a particular feature for a specificed userId e.g. `bulletTrain.getValue("font_size", 1234) // 15`
`getFlags()`	Trigger a manual fetch of the environment features, if a user is identified it will fetch their features
`getFlagsForUser(userId)`	Trigger a manual fetch of the environment features with a given userId
`setTrait(userId, key, value)`	Set the name/value pair for the specified userId
`getTrait(userId, key)`	Retrieve the value for the specified userId and Trait key

Identifying users

Identifying users allows you to target specific users from the Bullet Train dashboard. You can include an optional user identifier as part of the hasFeature and getValue methods to retrieve unique user flags and variables.

Contributing

Please read CONTRIBUTING.md for details on our code of conduct, and the process for submitting pull requests to us.

Getting Help

If you encounter a bug or feature request we would like to hear about it. Before you submit an issue please search existing issues in order to prevent duplicates.

Get in touch

If you have any questions about our projects you can email support@bullet-train.io.

Useful links

bullet-train-nodejs dependencies

node-fetch

FAQs

What is bullet-train-nodejs?

Bullet Train lets you manage features flags and remote config across web, mobile and server side applications. Deliver ... Visit Snyk Advisor to see a full health score report for bullet-train-nodejs, including popularity, security, maintenance & community analysis.

Is bullet-train-nodejs popular?

The npm package bullet-train-nodejs receives a total of 1 weekly downloads. As such, bullet-train-nodejs popularity was classified as limited. Visit the popularity section on Snyk Advisor to see the full health analysis.

Is bullet-train-nodejs well maintained?

We found indications that bullet-train-nodejs is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is bullet-train-nodejs safe to use?

The npm package bullet-train-nodejs was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 7 November-2024, at 18:01 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP