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

smoothsail-node-sdk

v1.0.6

Published

SmoothSail Server-side Node SDK

Downloads

3

Readme

Using the Node SDK

  1. Install the SmoothSail Node SDK in your project by running npm i smoothsail-node-sdk .
  2. Import the SmoothSailConfig file into whichever files you will be evaluating flags in.

import { SmoothSailConfig } from "smoothsail-node-sdk";

  1. Set up an environment variable for the SECRET_KEY. This should be the same secret used for SmoothSail's Manager.

  2. Use the SmoothSailConfig class constructor to instantiate a config object. The constructor takes two arguments:

  • (string) SDK Key, from SmoothSail's dashboard UI
  • (string) Address of SmoothSail's SDK Service
// shown as hard-coded but recommend having these as environment variables

const config = new SmoothSailConfig("SDK key", "SDK Service address");
  1. Instantiate a SmoothSailClient by calling config.connect(). Note that this is an asynchronous action so you will need to use async/await to perform this step.
const config = new SmoothSailConfig("SDK key", "bearer address");

let client;

// instantiate SmoothSailClient

(async () => {
  client = await config.connect();
})();
  1. Use the SmoothSailClient.prototype.evaluateFlag() method to evaluate flags. SmoothSailClient.prototype.evaluateFlag() takes 3 arguments:
  • (string) Flag Key, fKey from SmoothSail's dashboard UI
  • (object) User Context object
  • (boolean) Default value for flag evaluation, optional argument
let testUserContext = {
  user_name: "John Smith",
  "beta-tester": true,
};

router.get("/", async (req, res) => {
  if (client.evaluateFlag("flag-1", testUserContext, true)) {
    // execute process for beta tester
  } else {
    // execute stable process
  }
})