npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

@harnessio/ff-nodejs-server-sdk

v1.8.3

Published

Feature flags SDK for NodeJS environments

Downloads

58,178

Readme

Node.js SDK For Harness Feature Flags

TypeScript version Node.js version APLv2

Use this README to get started with our Feature Flags (FF) SDK for Node.js. This guide outlines the basics of getting started with the SDK and provides a full code sample for you to try out.

This sample doesn't include configuration options, for in depth steps and configuring the SDK, for example, disabling streaming or using our Relay Proxy, see the Node.js SDK Reference.

Requirements

To use this SDK, make sure you’ve:

  • Installed Node.js v12 or a newer version

To follow along with our test code sample, make sure you’ve:

Installing the SDK

The first step is to install the FF SDK as a dependency in your application. To install using npm, use:

npm install @harnessio/ff-nodejs-server-sdk

Or to install with yarn, use:

yarn add @harnessio/ff-nodejs-server-sdk

Code Sample

The following is a complete code example that you can use to test the harnessappdemodarkmode Flag you created on the Harness Platform. When you run the code it will:

  • Connect to the FF service.
  • Report the value of the Flag every 10 seconds until the connection is closed.
  • Listen for when the harnessappdemodarkmode Flag is toggled on or off on the Harness Platform and report the new value.
const { Client, Event } = require('@harnessio/ff-nodejs-server-sdk');

(async () => {
  // set apiKey to your SDK API Key
  const apiKey = 'YOUR_FF_SDK_KEY';

  // set flagName to your flag identifier from the UI
  const flagName = 'harnessappdemodarkmode';

  console.log('Harness SDK Getting Started');

  // Create Client
  const client = new Client(apiKey);

  // Create a target (different targets can receive different results based on rules.
  // Here we are including "location" as a custom attribute)
  const target = {
    identifier: 'nodeserversdk',
    name: 'NodeServerSDK',
    attributes: {
      location: 'emea',
    },
  };

  try {
    await client.waitForInitialization();
  } catch (e) {
    console.log("Error when authenticating Feature Flags client: " + e)
  }

  try {
    // Log the state of the flag every 10 seconds
    setInterval(async () => {
      const value = await client.boolVariation(flagName, target, false);
      console.log('Flag variation:', value);
    }, 10000);

    // We can also watch for the event when a flag changes
    client.on(Event.CHANGED, async (flagIdentifier) => {
      const value = await client.boolVariation(flagIdentifier, target, false);
      console.log(`${flagIdentifier} changed: ${value}`);
    });
  } catch (e) {
    console.error('Error:', e);
  }
})();

Running the example

To run the example, execute your script:

node example.js

When you're finished you can exit the example by stopping the process using control-c.

Using custom TLS certificates

If using a proxy or SMP instance that does not use a widely publicised pre-bundled CA you can provide your own CA using the tlsTrustedCa option. This option takes a path to a file that contains a bundle of certificates in PEM format. If this option is present, the HTTP client will ignore any pre-bundled certs so you need to include the entire certificate chain of your custom cert.

  const client = new Client(apiKey, {
    baseUrl: 'https://ffserver:8000/api/1.0',
    eventsUrl: 'https://ffserver:8001/api/1.0',
    tlsTrustedCa: 'path_to_cert_chain.crt',
  });

Additional Reading

For further examples and config options, see the Node.js SDK Reference and the test Node.js project. For more information about Feature Flags, see our Feature Flags documentation.