Skip to content

Latest commit

 

History

History
95 lines (71 loc) · 5.41 KB

README.md

File metadata and controls

95 lines (71 loc) · 5.41 KB
Raw

LaunchDarkly Vercel Edge SDK

NPM Actions Status Documentation NPM NPM

This library supports using Vercel Edge Config to replace the default in-memory feature store of the LaunchDarkly Node.js SDK.

The LaunchDarkly Vercel integration is required

This SDK requires LaunchDarkly's Vercel integration to push feature flag data into a Vercel Edge Config. The Vercel integration is available to customers on an Enterprise plan. To learn more, read about our pricing. To upgrade your plan, contact Sales.

For more information, see the Vercel SDK reference.

Install

npm i @launchdarkly/vercel-server-sdk

or yarn:

yarn add -D @launchdarkly/vercel-server-sdk

Quick start

Initialize the ldClient with the Vercel Edge SDK and your LaunchDarkly client-side ID:

import { createClient } from '@vercel/edge-config';

import { init } from '@launchdarkly/vercel-server-sdk';

const edgeClient = createClient(process.env.EDGE_CONFIG);
const ldClient = init('YOUR CLIENT-SIDE ID', edgeClient);

await ldClient.waitForInitialization();
const ldContext = {
  kind: 'org',
  key: 'my-org-key',
  someAttribute: 'my-attribute-value',
};
const flagValue = await ldClient.variation('my-flag', ldContext, true);

To learn more, see the examples in this repository or head straight to the complete reference guide for this SDK.

⚠️ experimental

This SDK has experimental support for sending analytic events to LaunchDarkly. It can be enabled by setting sendEvents to true in the SDK options.

const client = initLD(sdkKey, env.LD_KV, { sendEvents: true });

Developing this SDK

# at js-core repo root
yarn && yarn build && cd packages/sdk/vercel
# run tests
yarn test

Verifying SDK build provenance with the SLSA framework

LaunchDarkly uses the SLSA framework (Supply-chain Levels for Software Artifacts) to help developers make their supply chain more secure by ensuring the authenticity and build integrity of our published SDK packages. To learn more, see the provenance guide.

About LaunchDarkly

  • LaunchDarkly is a continuous delivery platform that provides feature flags as a service and allows developers to iterate quickly and safely. We allow you to easily flag your features and manage them from the LaunchDarkly dashboard. With LaunchDarkly, you can:
    • Roll out a new feature to a subset of your users (like a group of users who opt-in to a beta tester group), gathering feedback and bug reports from real-world use cases.
    • Gradually roll out a feature to an increasing percentage of users, and track the effect that the feature has on key metrics (for instance, how likely is a user to complete a purchase if they have feature A versus feature B?).
    • Turn off a feature that you realize is causing performance problems in production, without needing to re-deploy, or even restart the application with a changed configuration file.
    • Grant access to certain features based on user attributes, like payment plan (eg: users on the ‘gold’ plan get access to more features than users in the ‘silver’ plan).
    • Disable parts of your application to facilitate maintenance, without taking everything offline.
  • LaunchDarkly provides feature flag SDKs for a wide variety of languages and technologies. Read our documentation for a complete list.
  • Explore LaunchDarkly