Vercel SDK reference

Overview

This topic documents how to get started with the Vercel SDK, and links to reference information on all of the supported features.

The Vercel SDK is designed to be used with one of the LaunchDarkly client-side SDKs as follows:

• The Vercel SDK gets all flags at the edge for a given context, and bootstraps them onto a cached payload
• The client-side SDK initializes the bootstrapped payload
• The client-side SDK evaluates the flags and sends events back to LaunchDarkly

Getting started

To install and configure the Vercel SDK in an existing project:

After you complete the Creating a Vercel integration process, follow these instructions to start using the LaunchDarkly Vercel SDK.

First, install the Vercel SDK as a dependency in your application using your application's dependency manager.

Here's how:

yarn add @launchdarkly/vercel-server-sdk
COPY

Next, import the LaunchDarkly client in your application code:

import { init } from '@launchdarkly/vercel-server-sdk'
import { createClient } from '@vercel/edge-config'
COPY

After you install and import the SDK, create an edge client using your Edge Config ID. Then, initialize an LDClient using your LaunchDarkly client-side ID and this edge client.

Here's how:

const edgeConfigClient = createClient(process.env.EDGE_CONFIG)
const ldClient = init('<client-side-id-123abc>', edgeConfigClient)
await ldClient.waitForInitialization()
COPY

After you initialize the client, wait for the waitForInitialization function to resolve. When waitForInitialization is resolved, the client can serve feature flags.

Using the client, you can check which variation a particular context will receive for a given feature flag. In your Vercel Edge application, place the client.variation code so that it is invoked as needed.

Here is an example:

const ldContext = {
  kind: 'org',
  key: 'org-key-123abc',
  someAttribute: 'example-attribute-value',
}
const flagValue = await ldClient.variation('flag-key-123abc', ldContext, true)
COPY

Bootstrapping flags with Next.js

If you are using Next.js with Vercel, you can bootstrap feature flags on the Root Layout for use in the LaunchDarkly React SDK. To bootstrap flags, specify the root layout's runtime with a value of edge and pass the flags to a client component that initializes the LaunchDarkly React SDK.

The Vercel SDK's GitHub repository contains an example application that takes advantage of bootstrapping flags from the edge for use in the LaunchDarkly React SDK.

Promises and async

All asynchronous SDK methods that return a Promise are compatible with then/catch or async/await. You can use either.

Shut down the client

Shut down the client when your application terminates. To learn more, read Shutting down.

Supported features

This SDK supports the following features:

• Anonymous contexts and users
• Configuration
• Evaluating flags
• Flag evaluation reasons
• Getting all flags
• Logging configuration
• Secure mode
• Shutting down
• User and context configuration