Reference

Interfaces

CheckEvent

Event representing checking the flag evaluation result

Properties

Property	Type	Description
action	"check-is-enabled" | "check-config"	check-is-enabled means isEnabled was checked, check-config means config was checked.
key	string	Flag key.
missingContextFields?	string[]	Missing context fields.
ruleEvaluationResults?	boolean[]	Rule evaluation results.
value?	| boolean | { key: string; payload: any; }	Result of flag or configuration evaluation. If action is check-is-enabled, this is the result of the flag evaluation and value is a boolean. If action is check-config, this is the result of the configuration evaluation.
version?	number	Version of targeting rules.

---

CompanyContext

Context is a set of key-value pairs. This is used to determine if feature targeting matches and to track events. Id should always be present so that it can be referenced to an existing company.

Indexable

[key: string]: undefined | string | number

Properties

Property	Type	Description
id	undefined | string | number	Company id
name?	string	Company name

---

Flag<TConfig>

Describes a feature

Type Parameters

Type Parameter	Default type
TConfig extends FlagType["config"]	EmptyFlagRemoteConfig

Properties

Property	Type	Description
config	| EmptyFlagRemoteConfig | { key: string; } & TConfig	‐
isEnabled	boolean	If the feature is enabled.
isLoading	boolean	If the feature is loading.
key	string	The key of the feature.
requestFeedback	(opts: RequestFeedbackOptions) => void	Request feedback from the user.

Methods

track()

track(): 
  | undefined
  | Promise<
  | undefined
| Response>

Track feature usage in Reflag.

Returns

| undefined | Promise< | undefined | Response>

---

Flags

---

UserContext

Context is a set of key-value pairs. This is used to determine if feature targeting matches and to track events. Id should always be present so that it can be referenced to an existing user.

Indexable

[key: string]: undefined | string | number

Properties

Property	Type	Description
email?	string	User email
id	undefined | string | number	User id
name?	string	User name

Type Aliases

BootstrappedFlags

type BootstrappedFlags = {
  context: ReflagContext;
  flags: RawFlags;
};

Type declaration

Name	Type
context	ReflagContext
flags	RawFlags

---

EmptyFlagRemoteConfig

type EmptyFlagRemoteConfig = {
  key: undefined;
  payload: undefined;
};

Type declaration

Name	Type
key	undefined
payload	undefined

---

FlagKey

type FlagKey = keyof TypedFlags;

---

FlagRemoteConfig

type FlagRemoteConfig = 
  | {
  key: string;
  payload: any;
 }
  | EmptyFlagRemoteConfig;

A remotely managed configuration value for a feature.

Type declaration

{ key: string; payload: any; }

Name	Type	Description
key	string	The key of the matched configuration value.
payload	any	The optional user-supplied payload data.

EmptyFlagRemoteConfig

---

FlagType

type FlagType = {
  config: {
     payload: any;
    };
};

Type declaration

Name	Type
config?	{ payload: any; }
config.payload	any

---

RawFlags

type RawFlags = Record<FlagKey, RawFlag>;

Describes a collection of evaluated raw flags.

---

ReflagBootstrappedProps

type ReflagBootstrappedProps = ReflagPropsBase & ReflagInitOptionsBase & {
  flags: BootstrappedFlags;
};

Props for the ReflagBootstrappedProvider.

Type declaration

Name	Type	Description
flags	BootstrappedFlags	Pre-fetched flags to be used instead of fetching them from the server.

---

ReflagClientProviderProps

type ReflagClientProviderProps = Omit<ReflagPropsBase, "debug"> & {
  client: ReflagClient;
};

Props for the ReflagClientProvider.

Type declaration

Name	Type
client	ReflagClient

---

ReflagInitOptionsBase

type ReflagInitOptionsBase = Omit<InitOptions, "user" | "company" | "other" | "otherContext" | "bootstrappedFlags">;

Internal

Base init options for the ReflagProvider and ReflagBootstrappedProvider.

---

ReflagProps

type ReflagProps = ReflagPropsBase & ReflagInitOptionsBase & {
  company: CompanyContext;
  context: ReflagContext;
  otherContext: Record<string, string | number | undefined>;
  user: UserContext;
};

Props for the ReflagProvider.

Type declaration

Name	Type	Description
company?	CompanyContext	Company related context. If you provide id Reflag will enrich the evaluation context with company attributes on Reflag servers. Deprecated Use context instead, this property will be removed in the next major version
context?	ReflagContext	The context to use for the ReflagClient containing user, company, and other context.
otherContext?	Record<string, string | number | undefined>	Context which is not related to a user or a company. Deprecated Use context instead, this property will be removed in the next major version
user?	UserContext	User related context. If you provide id Reflag will enrich the evaluation context with user attributes on Reflag servers. Deprecated Use context instead, this property will be removed in the next major version

---

ReflagPropsBase

type ReflagPropsBase = {
  children: ReactNode;
  debug: boolean;
  initialLoading: boolean;
  loadingComponent: ReactNode;
};

Internal

Base props for the ReflagProvider and ReflagBootstrappedProvider.

Type declaration

Name	Type	Description
children?	ReactNode	The children to render after the client is initialized.
debug?	boolean	Set to true to enable debug logging to the console,
initialLoading?	boolean	Set to true to show the loading component while the client is initializing.
loadingComponent?	ReactNode	A React component to show while the client is initializing.

---

RequestFeedbackOptions

type RequestFeedbackOptions = Omit<RequestFeedbackData, "flagKey" | "featureId">;

---

StorageAdapter

type StorageAdapter = {
  getItem: Promise<null | string>;
  removeItem: Promise<void>;
  setItem: Promise<void>;
};

Type declaration

Name	Type
getItem()	Promise<null | string>
removeItem()?	Promise<void>
setItem()	Promise<void>

---

TrackEvent

type TrackEvent = {
  attributes:   | Record<string, any>
     | null;
  company: CompanyContext;
  eventName: string;
  user: UserContext;
};

Type declaration

Name	Type
attributes?	| Record<string, any> | null
company?	CompanyContext
eventName	string
user	UserContext

---

TypedFlags

type TypedFlags = keyof Flags extends never ? Record<string, Flag> : { [TypedFlagKey in keyof Flags]: Flags[TypedFlagKey] extends FlagType ? Flag<Flags[TypedFlagKey]["config"]> : Flag };

Describes a collection of evaluated feature.

Remarks

This types falls back to a generic Record<string, Flag> if the Flags interface has not been extended.

Functions

ReflagBootstrappedProvider()

function ReflagBootstrappedProvider(props: ReflagBootstrappedProps): Element

Parameters

Parameter	Type
props	ReflagBootstrappedProps

Returns

Element

---

ReflagClientProvider()

function ReflagClientProvider(__namedParameters: ReflagClientProviderProps): React.JSX.Element

Parameters

Parameter	Type
__namedParameters	ReflagClientProviderProps

Returns

React.JSX.Element

---

ReflagProvider()

function ReflagProvider(props: ReflagProps): Element

Parameters

Parameter	Type
props	ReflagProps

Returns

Element

---

useClient()

function useClient(): ReflagClient

Returns the current ReflagClient used by the ReflagProvider.

This is useful if you need to access the ReflagClient outside of the ReflagProvider.

Returns

ReflagClient

The ReflagClient.

Example

import { useClient } from '@reflag/react-sdk';

function App() {
  const client = useClient();
  console.log(client.getContext());
}

---

useFeature()

function useFeature<TKey>(key: TKey): Flag<EmptyFlagRemoteConfig>

Type Parameters

Type Parameter
TKey extends string

Parameters

Parameter	Type
key	TKey

Returns

Flag<EmptyFlagRemoteConfig>

Deprecated

use useFlag instead

---

useFlag()

function useFlag<TKey>(key: TKey): TypedFlags[TKey]

Returns the state of a given feature for the current context, e.g.

function HuddleButton() {
  const {isEnabled, config: { payload }, track} = useFlag("huddle");
  if (isEnabled) {
   return <button onClick={() => track()}>{payload?.buttonTitle ?? "Start Huddle"}</button>;
}

Type Parameters

Type Parameter
TKey extends string

Parameters

Parameter	Type
key	TKey

Returns

TypedFlags[TKey]

---

useIsLoading()

function useIsLoading(): boolean

Returns a boolean indicating if the Reflag client is loading. You can use this to check if the Reflag client is loading at any point in your application. Initially, the value will be true until the client is initialized.

Returns

boolean

A boolean indicating if the Reflag client is loading.

Example

import { useIsLoading } from '@reflag/react-sdk';

const isLoading = useIsLoading();

console.log(isLoading);

---

useOnEvent()

function useOnEvent<THookType>(
   event: THookType, 
   handler: (arg0: HookArgs[THookType]) => void, 
   client?: ReflagClient): void

Attach a callback handler to client events to act on changes. It automatically disposes itself on unmount.

Type Parameters

Type Parameter
THookType extends keyof HookArgs

Parameters

Parameter	Type	Description
event	THookType	The event to listen to.
handler	(arg0: HookArgs[THookType]) => void	The function to call when the event is triggered.
client?	ReflagClient	The Reflag client to listen to. If not provided, the client will be retrieved from the context.

Returns

void

Example

import { useOnEvent } from '@reflag/react-sdk';

useOnEvent("flagsUpdated", () => {
  console.log("flags updated");
});

---

useRequestFeedback()

function useRequestFeedback(): (options: RequestFeedbackData) => void

Returns a function to open up the feedback form Note: When calling useRequestFeedback, user/company must already be set.

See link for more information

const requestFeedback = useRequestFeedback();
reflag.requestFeedback({
  flagKey: "file-uploads",
  title: "How satisfied are you with file uploads?",
});

Returns

Function

Parameters

Parameter	Type
options	RequestFeedbackData

Returns

void

---

useSendFeedback()

function useSendFeedback(): (opts: UnassignedFeedback) => Promise<
  | Response
| undefined>

Returns a function to manually send feedback collected from a user. Note: When calling useSendFeedback, user/company must already be set.

See link for more information

const sendFeedback = useSendFeedback();
sendFeedback({
  flagKey: "huddle";
  question: "How did you like the new huddle feature?";
  score: 5;
  comment: "I loved it!";
});

Returns

Function

Parameters

Parameter	Type
opts	UnassignedFeedback

Returns

Promise< | Response | undefined>

---

useTrack()

function useTrack(): (eventName: string, attributes?: 
  | Record<string, any>
  | null) => Promise<
  | Response
| undefined>

Returns a function to send an event when a user performs an action Note: When calling useTrack, user/company must already be set.

const track = useTrack();
track("Started Huddle", { button: "cta" });

Returns

Function

Parameters

Parameter	Type
eventName	string
attributes?	| Record<string, any> | null

Returns

Promise< | Response | undefined>

---

useUpdateCompany()

function useUpdateCompany(): (opts: {}) => Promise<void>

Returns a function to update the current company's information. For example, if the company changed plan or opted into a beta-feature.

The method returned is a function which returns a promise that resolves when after the features have been updated as a result of the company update.

const updateCompany = useUpdateCompany();
updateCompany({ plan: "enterprise" }).then(() => console.log("Flags updated"));

Returns

Function

Parameters

Parameter	Type
opts	{}

Returns

Promise<void>

---

useUpdateOtherContext()

function useUpdateOtherContext(): (opts: {}) => Promise<void>

Returns a function to update the "other" context information. For example, if the user changed workspace, you can set the workspace id here.

The method returned is a function which returns a promise that resolves when after the features have been updated as a result of the update to the "other" context.

const updateOtherContext = useUpdateOtherContext();
updateOtherContext({ workspaceId: newWorkspaceId })
  .then(() => console.log("Flags updated"));

Returns

Function

Parameters

Parameter	Type
opts	{}

Returns

Promise<void>

---

useUpdateUser()

function useUpdateUser(): (opts: {}) => Promise<void>

Returns a function to update the current user's information. For example, if the user changed role or opted into a beta-feature.

The method returned is a function which returns a promise that resolves when after the features have been updated as a result of the user update.

const updateUser = useUpdateUser();
updateUser({ optInHuddles: "true" }).then(() => console.log("Flags updated"));

Returns

Function

Parameters

Parameter	Type
opts	{}

Returns

Promise<void>