Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
89 changes: 89 additions & 0 deletions apps/docs/content/docs/providers/openfeature/featureflip.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,89 @@
---
title: Featureflip
description: Use Featureflip with the Flags SDK
---

{/*
DO NOT EDIT THIS FILE DIRECTLY. IT IS AUTO-GENERATED.

Use pnpm generate-openfeature-providers to generate all OpenFeature providers.
*/}

Featureflip can be used with the Flags SDK through OpenFeature.
Set up the [Flags SDK adapter for OpenFeature](/providers/openfeature),
along with the [Featureflip OpenFeature provider](https://featureflip.io/docs/integrations/openfeature/) to get started.



## Installation

Install the following packages:

```bash
npm install flags @flags-sdk/openfeature @featureflip/node @featureflip/openfeature-node
```

## Setup

Set up your [Featureflip OpenFeature provider](https://featureflip.io/docs/integrations/openfeature/) as a Flags SDK adapter.

```ts
// adapter.ts
import { OpenFeature } from "@openfeature/server-sdk";
import { createOpenFeatureAdapter } from "@flags-sdk/openfeature";
import { FeatureflipProvider } from '@featureflip/openfeature-node';


export const openFeatureAdapter = createOpenFeatureAdapter(async () => {
const provider = new FeatureflipProvider({ sdkKey: 'SDK_KEY' });
await OpenFeature.setProviderAndWait(provider);
return OpenFeature.getClient();
});
```

See the [OpenFeature adapter](/providers/openfeature) for more details.

## Usage

Use your newly configured adapter when declaring flags.

```ts
// flags.ts
import { flag } from "flags/next";
import type { EvaluationContext } from "@openfeature/server-sdk";
import { openFeatureAdapter } from "./adapter";

export const exampleFlag = flag<boolean, EvaluationContext>({
key: "example-flag",
defaultValue: false,
adapter: openFeatureAdapter.booleanValue(),
});
```

## Resources

<LearnMore
icon="arrow"
href="/providers/openfeature"
>
Flags SDK adapter for OpenFeature
</LearnMore>


<LearnMore
icon="arrow"
href="https://featureflip.io/docs/integrations/openfeature/"
target="_blank"
>
Featureflip OpenFeature Provider
</LearnMore>


_Note that OpenFeature providers may require additional configuration for optimal performance and compatibility. Setup instructions are provided on a best effort basis. Refer to each provider's own documentation._

_If there is a native Flags SDK adapter for your provider, we recommend using that instead.
Native Flags SDK adapters tune your flag provider's SDK for optimal performance and integrate with Flags Explorer and Global Config.
See [available adapters](/docs/adapters/supported-providers#adapters)._

_If you are a feature flag provider interested in developing a native adapter please [open a GitHub issue](https://github.com/vercel/flags) to get in touch._

1 change: 1 addition & 0 deletions apps/docs/content/docs/providers/openfeature/meta.json
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
"configcat",
"devcycle",
"featbit",
"featureflip",
"flagd",
"flipt",
"go",
Expand Down