Node SDK

The Node SDK helps you integrate Unrevealed in a Node server.

For Node.js in a serverless environment, check the serverless SDK instead.

Getting Started

npm install @unrevealed/node

yarn add @unrevealed/node

pnpm install @unrevealed/node

Usage

UnrevealedClient

The Unrevealed client takes an UnrevealedClientOptions object as a parameter:

const client = new UnrevealedClient({
  apiKey: UNREVEALED_API_KEY,
  logger: customLogger,
  defaults: {
    'feature-key': true,
  },
});

| Option | Type | Note | | ---------- | ----------------------- | ----------------------------------------------------------------------------------------------------------------- | | apiKey* | string | Generate a Server API key on Unrevealed | | logger | UnrevealedLogger | An optional custom logger (compatible with winston loggers) | | defaults | Record<string, boolean> | An optional map of default value for your feature flags. Used if the connection gets lost with the Unrevealed API |

connect

await client.connect();

Call this once when initializing your server. The SDK will open a connection to our servers that will receive the rules for your feature flags, and real-time updates when any of those rules change. Rules are stored and evaluated locally, so evaluating feature flags is fast and synchronous.

close

client.close();

Closes the connection with the Unrevealed API.

isFeatureEnabled

client.isFeatureEnabled('feature-key', { user: { id: 'user-id', traits: {...} }, team: { id: 'team-id', traits: {...} } });

Returns true if a feature is enabled for a certain user in a certain team, false otherwise.

| Parameter | Type | Note | | -------------- | -------------------------------- | ---------------------------------------- | | featureKey* | string | The key of the feature you want to check | | options.user | { id: string, traits: object } | An optional user | | options.team | { id: string, traits: object } | An optional team |

getEnabledFeatures

client.getEnabledFeatures({ user: { id: 'user-id', traits: {...} }, team: { id: 'team-id', traits: {...} } });

Returns an array of the keys of all the features enabled for a certain user in a certain team.

| Parameter | Type | Note | | -------------- | -------------------------------- | ---------------- | | options.user | { id: string, traits: object } | An optional user | | options.team | { id: string, traits: object } | An optional team |

getFeatureAccess

client.getFeatureAccess('feature-key');

Returns a FeatureAccess object with the current access rules for the given feature:

interface FeatureAccess {
  fullAccess: boolean;
  userAccess: string[];
  teamAccess: string[];
  userPercentageAccess: number;
  teamPercentageAccess: number;
}

• fullAccess is true if the feature is enabled for every user
• userAccess is a list of user ids who have access to the feature
• teamAccess is a list of team ids who have access to the feature
• userPercentageAccess is a the percentage of users who have access to the feature if relevant
• teamPercentageAccess is a the percentage of teams who have access to the feature if relevant

Percentages are always between 0 and 100 and are 0 if no progressive rollout is in use for the given feature.

identify

await client.identify({ user: { id: 'user-id', traits: {...} }, team: { id: 'team-id', traits: {...} } });

Identifies a user and its current team. This will make the user and its team show up in the Unrevealed app, allowing you to select them for a beta for example.

Type safety

You can make the identify and isFeatureEnabled functions type safe by using the code generator, and defining the traits of your users and teams in the app.