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

@unrevealed/js

v0.1.0

Published

Unrevealed SDK for JavaScript

Downloads

223

Readme

JavaScript SDK

Integrate Unrevealed in your front-end applications

Getting Started

npm install @unrevealed/js
yarn add @unrevealed/js
pnpm install @unrevealed/js

Usage

UnrevealedClient

First, create an Unrevealed client by passing your client key. To generate a client key, go to the Api Keys menu in the app and create one. Select Client as the target SDK.

You should use different API keys for different environments.

import { UnrevealedClient } from '@unrevealed/js';

const client = new UnrevealedClient(yourClientKey);

Subscribe/Unsubscribe

You can subscribe to updates to the enabled features. The subscribe method returns a Symbol that can be used to unsubscribe.

Note that the client isn't receiving updates in real time. These callbacks are simply called when the client has finished fetching features when identifying a user.

const subscription = client.subscribe(
  (features) => {
    // ...
  },
  (err) => {
    // ...
  },
);

// ...

client.unsubscribe(subscription);

Identify the current user and team

This will fetch the features for the identified user, and save the user and team in Unrevealed.

client.identify({
  user: {
    id: user.id,
    traits: {
      email: user.email,
      name: user.name,
      // ...
    },
  },
  team: {
    id: team.id,
    traits: {
      name: team.name,
      plan: team.plan,
      // ...
    },
  },
});

Checking enabled features

const { enabled, loading } = client.getFeature('feature-key');

const enabledFeatureKeys = client.getEnabledFeatures();

Type safety

You can make the client type safe regarding feature keys and user/team traits by using the code generator.