This is page 5 of 5. Use http://codebase.md/bucketco/docs/.gitbook/assets/Monitor.png?lines=false&page={x} to view the full context.
# Directory Structure
```
├── .gitbook
│ ├── assets
│ │ ├── 03642c5-dwFrame_201 (1).png
│ │ ├── 03642c5-dwFrame_201.png
│ │ ├── 1753259671871 (1).jpeg
│ │ ├── 1a0b50d-image.png
│ │ ├── 1a439d9-image.png
│ │ ├── 2506596-Customized_Widgets.png
│ │ ├── 342658e-image.png
│ │ ├── 4017197-image.png
│ │ ├── 43e55f0-image.png
│ │ ├── 4783e3f-image.png
│ │ ├── 5b0ce63-image (1).png
│ │ ├── 5b0ce63-image.png
│ │ ├── 630b5e9-image.png
│ │ ├── 8bf8a6e-Frame_201.png
│ │ ├── 9efd67c-image.png
│ │ ├── aa37226-image.png
│ │ ├── Access (1) (1).png
│ │ ├── Access (1).png
│ │ ├── Access (2).png
│ │ ├── Access.png
│ │ ├── Adding features to a feature view-min.png
│ │ ├── Adopted-min.png
│ │ ├── Adoption strategy V2-min.png
│ │ ├── Adoption strategy-min.png
│ │ ├── Advanced targeting rules V2-min.png
│ │ ├── Advanced targeting rules v3-min.png
│ │ ├── Advanced targeting rules-min.png
│ │ ├── aecc6f2-image.png
│ │ ├── amplitude.svg
│ │ ├── An example targeting configuration with two rules.-min.png
│ │ ├── api.svg
│ │ ├── App Settings-min.png
│ │ ├── Automated feedback surveys settings v3-min.png
│ │ ├── Automated feedback surveys settings-min.png
│ │ ├── Automated feedback surveys-min.png
│ │ ├── aws-s3.svg
│ │ ├── be124cd-dwdwFrame_201 (1).png
│ │ ├── be124cd-dwdwFrame_201.png
│ │ ├── ccc4f9e-image.png
│ │ ├── CleanShot 2024-06-11 at 8 [email protected]
│ │ ├── CleanShot 2024-11-22 at 8 [email protected]
│ │ ├── CleanShot 2024-11-22 at 8 [email protected]
│ │ ├── CleanShot 2024-11-25 at 9 [email protected]
│ │ ├── CleanShot 2024-11-25 at 9 [email protected]
│ │ ├── CleanShot 2024-11-25 at 9 [email protected]
│ │ ├── CleanShot 2024-11-27 at 10 [email protected]
│ │ ├── CleanShot 2024-11-27 at 10 [email protected]
│ │ ├── CleanShot 2024-11-27 at 10 [email protected]
│ │ ├── CleanShot 2024-11-27 at 10 [email protected]
│ │ ├── CleanShot 2025-01-07 at 1 [email protected]
│ │ ├── CleanShot 2025-01-07 at 1 [email protected]
│ │ ├── CleanShot 2025-01-07 at 1 [email protected]
│ │ ├── CleanShot 2025-01-07 at 12 [email protected]
│ │ ├── CleanShot 2025-01-07 at 12 .39.12@2x (1).png
│ │ ├── CleanShot 2025-01-07 at 12 [email protected]
│ │ ├── CleanShot 2025-01-09 at 10 [email protected]
│ │ ├── CleanShot 2025-01-09 at 11 .11.54@2x (1).png
│ │ ├── CleanShot 2025-01-09 at 11 [email protected]
│ │ ├── CleanShot 2025-01-09 at 9 [email protected]
│ │ ├── CleanShot 2025-01-23 at 1 [email protected]
│ │ ├── CleanShot 2025-01-23 at 1 [email protected]
│ │ ├── CleanShot 2025-01-23 at 1 [email protected]
│ │ ├── CleanShot 2025-01-23 at 2 [email protected]
│ │ ├── CleanShot 2025-05-09 at 1 [email protected]
│ │ ├── CleanShot 2025-10-09 at 10 [email protected]
│ │ ├── Companies Tab-min.png
│ │ ├── Companies-min.png
│ │ ├── company example v2-min (1).png
│ │ ├── company example v2-min.png
│ │ ├── company example v3-min.png
│ │ ├── Company segment filters-min.png
│ │ ├── Create a new environment-min.png
│ │ ├── Creating and managing apps-min.png
│ │ ├── cursor-mcp-demo_h264.mp4
│ │ ├── datadog.svg
│ │ ├── Debugger-min (1).png
│ │ ├── Debugger-min (2).png
│ │ ├── Debugger-min.png
│ │ ├── Enabling Feedback Surveys-min.png
│ │ ├── Environments Page V2-min.png
│ │ ├── Environments Switcher-min.png
│ │ ├── Environments-min.png
│ │ ├── Evaluate Feature.png
│ │ ├── example 1 (1).png
│ │ ├── example 1.png
│ │ ├── example 2 (1).png
│ │ ├── example 2.png
│ │ ├── ezgif-242d06617aea38.gif
│ │ ├── Feature Tab-min.png
│ │ ├── Feature targeting rules example v2-min.png
│ │ ├── Feature targeting rules example V2-min.png
│ │ ├── Feature targeting rules example v3-min.png
│ │ ├── Feature targeting rules example-min.png
│ │ ├── Feature targeting rules UI V2-min.png
│ │ ├── Feature targeting rules UI v3-min.png
│ │ ├── Feature targeting rules UI-min.png
│ │ ├── Feature usage configuration-v2-min.png
│ │ ├── Feature view.png
│ │ ├── feature-flag-list-rum-event.d9c1c876a34458edc70d1317efaec05b.png.avif
│ │ ├── Feature-targeting-rules-v2-min.png
│ │ ├── Features Page V2-min (1).png
│ │ ├── Features Page V2-min.png
│ │ ├── Features Page-min.png
│ │ ├── Features-min.png
│ │ ├── Feedback Tab V2-min.png
│ │ ├── Feedback-min.png
│ │ ├── Getting started-min.png
│ │ ├── gitbook-logo.svg
│ │ ├── github-logo.svg
│ │ ├── Global settings - Feature views-min.png
│ │ ├── Global settings - Manual Targeting-min.png
│ │ ├── Global settings - Release Stages Editing V4-min.png
│ │ ├── Global settings - Release Stages-min.png
│ │ ├── Goal Form.png
│ │ ├── How to use release stages v2-min.png
│ │ ├── How to use release stages-min (1).png
│ │ ├── How to use release stages-min.png
│ │ ├── https___content.gitbook.com_content_pgXAy2Cgsm5pON9oJ06m_blobs_6wGbrQlJPE4JllBuIhla_image (1).png
│ │ ├── image (1) (1).png
│ │ ├── image (1) (2).png
│ │ ├── image (1).png
│ │ ├── image (10).png
│ │ ├── image (11).png
│ │ ├── image (12).png
│ │ ├── image (13).png
│ │ ├── image (14).png
│ │ ├── image (15).png
│ │ ├── image (16).png
│ │ ├── image (17).png
│ │ ├── image (18).png
│ │ ├── image (19).png
│ │ ├── image (2) (1).png
│ │ ├── image (2).png
│ │ ├── image (20).png
│ │ ├── image (21).png
│ │ ├── image (22).png
│ │ ├── image (23).png
│ │ ├── image (24).png
│ │ ├── image (25).png
│ │ ├── image (26).png
│ │ ├── image (27).png
│ │ ├── image (28).png
│ │ ├── image (29).png
│ │ ├── image (3).png
│ │ ├── image (30).png
│ │ ├── image (31).png
│ │ ├── image (32).png
│ │ ├── image (33).png
│ │ ├── image (4).png
│ │ ├── image (5).png
│ │ ├── image (6).png
│ │ ├── image (7).png
│ │ ├── image (8).png
│ │ ├── image (9).png
│ │ ├── image.png
│ │ ├── Iterate Feature V2.png
│ │ ├── LInear mention.mp4
│ │ ├── linear.svg
│ │ ├── mcp-remote-min.mp4
│ │ ├── mcp-remote.mp4
│ │ ├── mixpanel.svg
│ │ ├── Modifying or deleting an app-min.png
│ │ ├── Monitor (1) (1).png
│ │ ├── Monitor (1).png
│ │ ├── Monitor (2).png
│ │ ├── Monitor (3).png
│ │ ├── Monitor (4).png
│ │ ├── Monitor (5).png
│ │ ├── Monitor (6).png
│ │ ├── Monitor (7).png
│ │ ├── Monitor.png
│ │ ├── New feature.png
│ │ ├── next-js.svg
│ │ ├── node-js.svg
│ │ ├── openfeature.svg
│ │ ├── posthog.svg
│ │ ├── Pre-Release.png
│ │ ├── react.svg
│ │ ├── Release Goals.png
│ │ ├── Release Stage Beta Targeting Rules v3-min.png
│ │ ├── Release Stage Beta Targeting Rules V3-min.png
│ │ ├── Release Stage Beta Targeting Rules V5-min.png
│ │ ├── Release Stage Beta Targeting Rules-min.png
│ │ ├── remote config - 3.png
│ │ ├── Remote config.png
│ │ ├── Rolling back flags-V2.png
│ │ ├── Rules in other environments.png
│ │ ├── rum-explorer-error-feature-flag-search.7b9f6c046db1de1c71d279c139f1508a.png.avif
│ │ ├── rum-explorer-session-feature-flag-search.435802460fd607608ad5155f029da57b.png.avif
│ │ ├── Satisfaction feedback-min.png
│ │ ├── Satisified-min.png
│ │ ├── Save the segment-min.png
│ │ ├── Saving New Segment-min.png
│ │ ├── Screenshot 2024-08-14 at 19.25.06 (1).png
│ │ ├── Screenshot 2024-08-14 at 19.25.06.png
│ │ ├── Screenshot 2024-08-15 at 13.57.46.png
│ │ ├── Screenshot 2024-10-10 at 14.04.09.png
│ │ ├── Screenshot 2024-10-10 at 14.04.34.png
│ │ ├── Screenshot 2025-07-10 at 14.04.07.png
│ │ ├── Screenshot 2025-07-10 at 14.11.01.png
│ │ ├── Screenshot 2025-07-10 at 14.29.20.png
│ │ ├── Screenshot 2025-07-15 at 21.31.16.png
│ │ ├── Screenshot 2025-07-21 at 20.07.27.png
│ │ ├── Screenshot 2025-09-02 at 17.08.25.png
│ │ ├── Screenshot 2025-09-02 at 17.10.36 (1).png
│ │ ├── Screenshot 2025-09-02 at 17.10.36 (2).png
│ │ ├── Screenshot 2025-09-02 at 17.10.36.png
│ │ ├── Screenshot 2025-09-02 at 17.11.21 (1).png
│ │ ├── Screenshot 2025-09-02 at 17.11.21.png
│ │ ├── Screenshot 2025-09-02 at 17.13.15 (1).png
│ │ ├── Screenshot 2025-09-02 at 17.13.15.png
│ │ ├── Screenshot 2025-09-02 at 17.19.44 (1).png
│ │ ├── Screenshot 2025-09-02 at 17.19.44.png
│ │ ├── Screenshot 2025-09-09 at 09.32.31.png
│ │ ├── Screenshot 2025-09-12 at 11.50.41.png
│ │ ├── Screenshot 2025-09-12 at 12.30.38.png
│ │ ├── Screenshot 2025-09-12 at 13.14.44.png
│ │ ├── Screenshot 2025-09-12 at 13.18.07.png
│ │ ├── Screenshot 2025-09-12 at 13.21.25.png
│ │ ├── Screenshot 2025-09-12 at 13.25.21.png
│ │ ├── Screenshot 2025-09-12 at 14.29.56.png
│ │ ├── Screenshot 2025-09-12 at 14.37.52.png
│ │ ├── Screenshot 2025-09-12 at 14.58.27.png
│ │ ├── Screenshot 2025-09-12 at 15.00.32.png
│ │ ├── Screenshot 2025-09-12 at 15.01.32.png
│ │ ├── Screenshot 2025-09-12 at 15.03.33.png
│ │ ├── Screenshot 2025-09-12 at 15.04.39.png
│ │ ├── Screenshot 2025-09-12 at 15.06.50.png
│ │ ├── Screenshot 2025-09-12 at 15.13.45.png
│ │ ├── Screenshot 2025-09-12 at 15.14.43.png
│ │ ├── Screenshot 2025-09-12 at 15.16.42.png
│ │ ├── Screenshot 2025-09-12 at 15.18.42.png
│ │ ├── Screenshot 2025-09-12 at 15.32.39.png
│ │ ├── Screenshot 2025-09-12 at 15.33.57.png
│ │ ├── Screenshot 2025-09-12 at 15.35.09.png
│ │ ├── Screenshot 2025-09-12 at 15.36.14.png
│ │ ├── segment (1).svg
│ │ ├── segment.svg
│ │ ├── Segments.png
│ │ ├── Set segment conditions-min.png
│ │ ├── Setting multiple targeting rules.png
│ │ ├── Setting Tab-min.png
│ │ ├── Setting targeting rules v3-min.png
│ │ ├── Setting targeting rules-min.png
│ │ ├── Settings-min (1).png
│ │ ├── Settings-min.png
│ │ ├── slack (1).svg
│ │ ├── Slack (with auto-layout)-min.png
│ │ ├── Slack and Environments-min.png
│ │ ├── Slack and Feature views-min.png
│ │ ├── Slack Integration.png
│ │ ├── Slack Settings under Features-min.png
│ │ ├── Slack with User Feedback.png
│ │ ├── slack.svg
│ │ ├── slackConnected (1).png
│ │ ├── slackConnected.png
│ │ ├── slackDisconnected (1).png
│ │ ├── slackDisconnected.png
│ │ ├── STARS Configuration-min.png
│ │ ├── STARS Feature Funnel-min.png
│ │ ├── STARS Feature Report-min.png
│ │ ├── STARS states.png
│ │ ├── surveys-min.png
│ │ ├── Switching Between Environments-min.png
│ │ ├── Targeting rules interface-min.png
│ │ ├── Targeting rules.png
│ │ ├── There are 5 different types of conditions to chose from-min.png
│ │ ├── Track adoption in the UI V2-min.png
│ │ ├── Track adoption in the UI v3-min.png
│ │ ├── Track adoption in the UI-min.png
│ │ ├── Track new feature V2-min.png
│ │ ├── Tracking Tab-min.png
│ │ ├── ts-js.svg
│ │ ├── type-check-failed.png
│ │ ├── type-check-payload-failed.png
│ │ ├── usage attribute example v3.png
│ │ ├── usage attribute example-min.png
│ │ ├── Usage configuration-min.png
│ │ ├── vercel-logo.svg
│ │ ├── vue-logo.svg
│ │ ├── What is the STARS Framework v3-min.png
│ │ └── What is the STARS Framework_-min.png
│ └── includes
│ ├── integrations.md
│ ├── languages.md
│ ├── need-some-help-chat-with-us.md
│ ├── sdks.md
│ └── untitled.md
├── .github
│ └── README.md
├── .vscode
│ └── settings.json
├── api
│ ├── api-access.md
│ ├── cli.md
│ ├── mcp.md
│ ├── public-api
│ │ ├── public-api-reference.md
│ │ └── README.md
│ └── reflag-rest-api
│ ├── README.md
│ └── reflag-api-reference.md
├── guides
│ ├── self-opt-in.md
│ └── use-reflag-in-your-cli.md
├── integrations
│ ├── amplitude.md
│ ├── aws-s3.md
│ ├── cursor.md
│ ├── datadog.md
│ ├── github.md
│ ├── linear.md
│ ├── mixpanel.md
│ ├── overview.md
│ ├── posthog.md
│ ├── segment.md
│ └── slack.md
├── introduction
│ └── concepts
│ ├── app.md
│ ├── company.md
│ ├── environment.md
│ ├── event.md
│ ├── feature-events.md
│ ├── feature-view.md
│ ├── feature.md
│ ├── feedback.md
│ ├── filter.md
│ ├── README.md
│ ├── release-stage.md
│ ├── segment.md
│ ├── targeting-rules.md
│ └── user.md
├── product-handbook
│ ├── anonymous-users.md
│ ├── concepts
│ │ ├── app.md
│ │ ├── company.md
│ │ ├── environment.md
│ │ ├── event.md
│ │ ├── feature-events.md
│ │ ├── feature-view.md
│ │ ├── feature.md
│ │ ├── feedback.md
│ │ ├── filter.md
│ │ ├── README.md
│ │ ├── release-stage.md
│ │ ├── segment.md
│ │ ├── targeting-rules.md
│ │ └── user.md
│ ├── creating-and-managing-apps
│ │ ├── environments.md
│ │ └── README.md
│ ├── creating-and-managing-apps.md
│ ├── creating-segments.md
│ ├── data-export.md
│ ├── data-residency.md
│ ├── feature-clean-up-and-archival-beta
│ │ ├── ai-code-clean-up-beta.md
│ │ └── README.md
│ ├── feature-entitlements
│ │ ├── README.md
│ │ └── simple-role-based-entitlements.md
│ ├── feature-rollouts
│ │ ├── feature-targeting-rules.md
│ │ └── README.md
│ ├── feature-targeting-rules
│ │ ├── creating-segments.md
│ │ └── environments.md
│ ├── feature-views.md
│ ├── launch-monitor
│ │ ├── automated-feedback-surveys.md
│ │ ├── give-feedback-button.md
│ │ └── README.md
│ ├── product-overview.md
│ ├── remote-config.md
│ ├── self-opt-in.md
│ ├── service-resiliency.md
│ ├── team-permissions.md
│ └── type-safety.md
├── README.md
├── sdk
│ ├── _media
│ │ ├── type-check-failed.png
│ │ └── type-check-payload-failed.png
│ ├── @reflag
│ │ ├── browser-sdk
│ │ │ ├── globals.md
│ │ │ └── README.md
│ │ ├── node-sdk
│ │ │ ├── globals.md
│ │ │ └── README.md
│ │ ├── react-sdk
│ │ │ ├── globals.md
│ │ │ └── README.md
│ │ └── vue-sdk
│ │ ├── globals.md
│ │ └── README.md
│ ├── documents
│ │ ├── browser-sdk
│ │ │ └── FEEDBACK.md
│ │ └── cli
│ │ └── README.md
│ └── README.md
├── SUMMARY.md
├── support
│ └── get-support.md
└── supported-languages
├── next.js.md
├── openfeature.md
├── overview.md
└── ruby-rails-stimulus.md
```
# Files
--------------------------------------------------------------------------------
/sdk/@reflag/node-sdk/globals.md:
--------------------------------------------------------------------------------
```markdown
---
layout:
visible: true
title:
visible: true
description:
visible: false
tableOfContents:
visible: true
outline:
visible: true
pagination:
visible: true
---
# @reflag/node-sdk
## Classes
### BoundReflagClient
A client bound with a specific user, company, and other context.
#### Constructors
##### new BoundReflagClient()
```ts
new BoundReflagClient(client: ReflagClient, options: ContextWithTracking): BoundReflagClient
```
**`Internal`**
(Internal) Creates a new BoundReflagClient. Use `bindClient` to create a new client bound with a specific context.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`client`
</td>
<td>
[`ReflagClient`](globals.md#reflagclient)
</td>
<td>
The `ReflagClient` to use.
</td>
</tr>
<tr>
<td>
`options`
</td>
<td>
[`ContextWithTracking`](globals.md#contextwithtracking)
</td>
<td>
The options for the client.
</td>
</tr>
</tbody>
</table>
###### Returns
[`BoundReflagClient`](globals.md#boundreflagclient)
#### Accessors
##### company
###### Get Signature
```ts
get company():
| undefined
| {
[k: string]: any; avatar: string;
id: undefined | string | number;
name: string;
}
```
Gets the company associated with the client.
###### Returns
\| `undefined`
\| \{
`[k: string]`: `any`; `avatar`: `string`;
`id`: `undefined` \| `string` \| `number`;
`name`: `string`;
\}
The company or `undefined` if it is not set.
##### otherContext
###### Get Signature
```ts
get otherContext():
| undefined
| Record<string, any>
```
Gets the "other" context associated with the client.
###### Returns
\| `undefined`
\| [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>
The "other" context or `undefined` if it is not set.
##### user
###### Get Signature
```ts
get user():
| undefined
| {
[k: string]: any; avatar: string;
email: string;
id: undefined | string | number;
name: string;
}
```
Gets the user associated with the client.
###### Returns
\| `undefined`
\| \{
`[k: string]`: `any`; `avatar`: `string`;
`email`: `string`;
`id`: `undefined` \| `string` \| `number`;
`name`: `string`;
\}
The user or `undefined` if it is not set.
#### Methods
##### bindClient()
```ts
bindClient(context: ContextWithTracking): BoundReflagClient
```
Create a new client bound with the additional context.
Note: This performs a shallow merge for user/company/other individually.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`context`
</td>
<td>
[`ContextWithTracking`](globals.md#contextwithtracking)
</td>
<td>
The context to bind the client to.
</td>
</tr>
</tbody>
</table>
###### Returns
[`BoundReflagClient`](globals.md#boundreflagclient)
new client bound with the additional context
##### flush()
```ts
flush(): Promise<void>
```
Flushes the batch buffer.
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
##### getFlag()
```ts
getFlag<TKey>(key: TKey): Flag
```
Get a specific flag for the user/company/other context bound to this client.
Using the `isEnabled` property sends a `check` event to Reflag.
###### Type Parameters
<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`TKey` *extends* `string`
</td>
</tr>
</tbody>
</table>
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`key`
</td>
<td>
`TKey`
</td>
<td>
The key of the flag to get.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Flag`](globals.md#flagtconfig)
Flags for the given user/company and whether each one is enabled or not
##### getFlagRemote()
```ts
getFlagRemote(key: string): Promise<Flag>
```
Get remotely evaluated flag for the user/company/other context bound to this client.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`key`
</td>
<td>
`string`
</td>
<td>
The key of the flag to get.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Flag`](globals.md#flagtconfig)\>
Flag for the given user/company and key and whether it's enabled or not
##### getFlags()
```ts
getFlags(): Record<string, Flag>
```
Get flags for the user/company/other context bound to this client.
Meant for use in serialization of flags for transferring to the client-side/browser.
###### Returns
[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`Flag`](globals.md#flagtconfig)\>
Flags for the given user/company and whether each one is enabled or not
##### getFlagsForBootstrap()
```ts
getFlagsForBootstrap(): BootstrappedFlags
```
Get raw flags for the user/company/other context bound to this client without wrapping them in getters.
This method returns raw flag data suitable for bootstrapping client-side applications.
###### Returns
[`BootstrappedFlags`](globals.md#bootstrappedflags)
Raw flags for the given user/company and whether each one is enabled or not
##### getFlagsRemote()
```ts
getFlagsRemote(): Promise<Record<string, Flag>>
```
Get remotely evaluated flag for the user/company/other context bound to this client.
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`Flag`](globals.md#flagtconfig)\>\>
Flags for the given user/company and whether each one is enabled or not
##### track()
```ts
track(event: string, options?: TrackOptions & {
companyId: string;
}): Promise<void>
```
Track an event in Reflag.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`event`
</td>
<td>
`string`
</td>
<td>
The event to track.
</td>
</tr>
<tr>
<td>
`options`?
</td>
<td>
[`TrackOptions`](globals.md#trackoptions) & \{ `companyId`: `string`; \}
</td>
<td>
The options for the event.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Throws
An error if the event is invalid or the options are invalid.
***
### EdgeClient
The EdgeClient is ReflagClient pre-configured to be used in edge runtimes, like
Cloudflare Workers.
#### Example
```ts
// set the REFLAG_SECRET_KEY environment variable or pass the secret key in the constructor
const client = new EdgeClient();
// evaluate a flag
const context = {
user: { id: "user-id" },
company: { id: "company-id" },
}
const { isEnabled } = client.getFlag(context, "flag-key");
```
#### Extends
- [`ReflagClient`](globals.md#reflagclient)
#### Constructors
##### new EdgeClient()
```ts
new EdgeClient(options: EdgeClientOptions): EdgeClient
```
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`options`
</td>
<td>
[`EdgeClientOptions`](globals.md#edgeclientoptions)
</td>
</tr>
</tbody>
</table>
###### Returns
[`EdgeClient`](globals.md#edgeclient)
###### Overrides
[`ReflagClient`](globals.md#reflagclient).[`constructor`](globals.md#constructors-2)
#### Properties
<table>
<thead>
<tr>
<th>Property</th>
<th>Modifier</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="httpclient"></a> `httpClient`
</td>
<td>
`public`
</td>
<td>
[`HttpClient`](globals.md#httpclient-2)
</td>
<td>
‐
</td>
</tr>
<tr>
<td>
<a id="logger"></a> `logger`
</td>
<td>
`readonly`
</td>
<td>
[`Logger`](globals.md#logger-2)
</td>
<td>
Gets the logger associated with the client.
</td>
</tr>
</tbody>
</table>
#### Accessors
##### flagOverrides
###### Set Signature
```ts
set flagOverrides(overrides:
| Partial<Record<string, FlagOverride>>
| FlagOverridesFn): void
```
Sets the flag overrides.
###### Remarks
The flag overrides are used to override the flag definitions.
This is useful for testing or development.
###### Example
```ts
client.flagOverrides = {
"flag-1": true,
"flag-2": false,
};
```
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`overrides`
</td>
<td>
\| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`FlagOverride`](globals.md#flagoverride)\>\> \| [`FlagOverridesFn`](globals.md#flagoverridesfn)
</td>
<td>
The flag overrides.
</td>
</tr>
</tbody>
</table>
###### Returns
`void`
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`flagOverrides`](globals.md#flagoverrides-1)
#### Methods
##### bindClient()
```ts
bindClient(context: ContextWithTracking): BoundReflagClient
```
Returns a new BoundReflagClient with the user/company/otherContext
set to be used in subsequent calls.
For example, for evaluating flag targeting or tracking events.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`context`
</td>
<td>
[`ContextWithTracking`](globals.md#contextwithtracking)
</td>
<td>
The context to bind the client to.
</td>
</tr>
</tbody>
</table>
###### Returns
[`BoundReflagClient`](globals.md#boundreflagclient)
A new client bound with the arguments given.
###### Throws
An error if the user/company is given but their ID is not a string.
###### Remarks
The `updateUser` / `updateCompany` methods will automatically be called when
the user/company is set respectively.
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`bindClient`](globals.md#bindclient-2)
##### clearFlagOverrides()
```ts
clearFlagOverrides(): void
```
Clears the flag overrides.
###### Returns
`void`
###### Remarks
This is useful for testing or development.
###### Example
```ts
afterAll(() => {
client.clearFlagOverrides();
});
```
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`clearFlagOverrides`](globals.md#clearflagoverrides-1)
##### destroy()
```ts
destroy(): void
```
Destroys the client and cleans up all resources including timers and background processes.
###### Returns
`void`
###### Remarks
After calling this method, the client should not be used anymore.
This is particularly useful in development environments with hot reloading to prevent
multiple background processes from running simultaneously.
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`destroy`](globals.md#destroy-1)
##### flush()
```ts
flush(): Promise<void>
```
Flushes and completes any in-flight fetches in the flag cache.
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Remarks
It is recommended to call this method when the application is shutting down to ensure all events are sent
before the process exits.
This method is automatically called when the process exits if `batchOptions.flushOnExit` is `true` in the options (default).
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`flush`](globals.md#flush-2)
##### getFlag()
```ts
getFlag<TKey>(__namedParameters: ContextWithTracking, key: TKey): Flag
```
Gets the evaluated flag for the current context which includes the user, company, and custom context.
Using the `isEnabled` property sends a `check` event to Reflag.
###### Type Parameters
<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`TKey` *extends* `string`
</td>
</tr>
</tbody>
</table>
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`__namedParameters`
</td>
<td>
[`ContextWithTracking`](globals.md#contextwithtracking)
</td>
<td>
‐
</td>
</tr>
<tr>
<td>
`key`
</td>
<td>
`TKey`
</td>
<td>
The key of the flag to get.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Flag`](globals.md#flagtconfig)
The evaluated flag.
###### Remarks
Call `initialize` before calling this method to ensure the flag definitions are cached, no flags will be returned otherwise.
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`getFlag`](globals.md#getflag-2)
##### getFlagDefinitions()
```ts
getFlagDefinitions(): FlagDefinition[]
```
Gets the flag definitions, including all config values.
To evaluate which flags are enabled for a given user/company, use `getFlags`.
###### Returns
[`FlagDefinition`](globals.md#flagdefinition)[]
The flags definitions.
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`getFlagDefinitions`](globals.md#getflagdefinitions-1)
##### getFlagRemote()
```ts
getFlagRemote<TKey>(
key: TKey,
userId?: IdType,
companyId?: IdType,
additionalContext?: Context): Promise<Flag>
```
Gets evaluated flag with the usage of remote context.
This method triggers a network request every time it's called.
###### Type Parameters
<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`TKey` *extends* `string`
</td>
</tr>
</tbody>
</table>
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`key`
</td>
<td>
`TKey`
</td>
<td>
The key of the flag to get.
</td>
</tr>
<tr>
<td>
`userId`?
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The userId of the user to get the flag for.
</td>
</tr>
<tr>
<td>
`companyId`?
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The companyId of the company to get the flag for.
</td>
</tr>
<tr>
<td>
`additionalContext`?
</td>
<td>
[`Context`](globals.md#context-1)
</td>
<td>
The additional context to get the flag for.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Flag`](globals.md#flagtconfig)\>
evaluated flag
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`getFlagRemote`](globals.md#getflagremote-2)
##### getFlags()
```ts
getFlags(options: ContextWithTracking): Record<string, Flag>
```
Gets the evaluated flags for the current context which includes the user, company, and custom context.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`options`
</td>
<td>
[`ContextWithTracking`](globals.md#contextwithtracking)
</td>
<td>
The options for the context.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`Flag`](globals.md#flagtconfig)\>
The evaluated flags.
###### Remarks
Call `initialize` before calling this method to ensure the flag definitions are cached, no flags will be returned otherwise.
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`getFlags`](globals.md#getflags-2)
##### getFlagsForBootstrap()
```ts
getFlagsForBootstrap(options: ContextWithTracking): BootstrappedFlags
```
Gets the evaluated flags for the current context without wrapping them in getters.
This method returns raw flag data suitable for bootstrapping client-side applications.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`options`
</td>
<td>
[`ContextWithTracking`](globals.md#contextwithtracking)
</td>
<td>
The options for the context.
</td>
</tr>
</tbody>
</table>
###### Returns
[`BootstrappedFlags`](globals.md#bootstrappedflags)
The evaluated raw flags and the context.
###### Remarks
Call `initialize` before calling this method to ensure the flag definitions are cached, no flags will be returned otherwise.
This method returns RawFlag objects without wrapping them in getters, making them suitable for serialization.
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`getFlagsForBootstrap`](globals.md#getflagsforbootstrap-2)
##### getFlagsRemote()
```ts
getFlagsRemote(
userId?: IdType,
companyId?: IdType,
additionalContext?: Context): Promise<Record<string, Flag>>
```
Gets evaluated flags with the usage of remote context.
This method triggers a network request every time it's called.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`userId`?
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The userId of the user to get the flags for.
</td>
</tr>
<tr>
<td>
`companyId`?
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The companyId of the company to get the flags for.
</td>
</tr>
<tr>
<td>
`additionalContext`?
</td>
<td>
[`Context`](globals.md#context-1)
</td>
<td>
The additional context to get the flags for.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`Flag`](globals.md#flagtconfig)\>\>
evaluated flags
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`getFlagsRemote`](globals.md#getflagsremote-2)
##### initialize()
```ts
initialize(): Promise<void>
```
Initializes the client by caching the flags definitions.
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Remarks
Call this method before calling `getFlags` to ensure the flag definitions are cached.
The client will ignore subsequent calls to this method.
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`initialize`](globals.md#initialize-1)
##### track()
```ts
track(
userId: IdType,
event: string,
options?: TrackOptions & {
companyId: IdType;
}): Promise<void>
```
Tracks an event in Reflag.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`userId`
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
</tr>
<tr>
<td>
`event`
</td>
<td>
`string`
</td>
</tr>
<tr>
<td>
`options`?
</td>
<td>
[`TrackOptions`](globals.md#trackoptions) & \{ `companyId`: [`IdType`](globals.md#idtype); \}
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Throws
An error if the user is not set or the event is invalid or the options are invalid.
###### Remarks
If the company is set, the event will be associated with the company.
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`track`](globals.md#track-2)
##### updateCompany()
```ts
updateCompany(companyId: IdType, options?: TrackOptions & {
userId: IdType;
}): Promise<void>
```
Updates the associated company in Reflag.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`companyId`
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The companyId of the company to update.
</td>
</tr>
<tr>
<td>
`options`?
</td>
<td>
[`TrackOptions`](globals.md#trackoptions) & \{ `userId`: [`IdType`](globals.md#idtype); \}
</td>
<td>
The options for the company.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Throws
An error if the company is not set or the options are invalid.
###### Remarks
The company must be set using `withCompany` before calling this method.
If the user is set, the company will be associated with the user.
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`updateCompany`](globals.md#updatecompany-1)
##### updateUser()
```ts
updateUser(userId: IdType, options?: TrackOptions): Promise<void>
```
Updates the associated user in Reflag.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`userId`
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The userId of the user to update.
</td>
</tr>
<tr>
<td>
`options`?
</td>
<td>
[`TrackOptions`](globals.md#trackoptions)
</td>
<td>
The options for the user.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Throws
An error if the company is not set or the options are invalid.
###### Remarks
The company must be set using `withCompany` before calling this method.
If the user is set, the company will be associated with the user.
###### Inherited from
[`ReflagClient`](globals.md#reflagclient).[`updateUser`](globals.md#updateuser-1)
***
### ReflagClient
The SDK client.
#### Remarks
This is the main class for interacting with Reflag.
It is used to evaluate flags, update user and company contexts, and track events.
#### Example
```ts
// set the REFLAG_SECRET_KEY environment variable or pass the secret key to the constructor
const client = new ReflagClient();
// evaluate a flag
const isFlagEnabled = client.getFlag("flag-key", {
user: { id: "user-id" },
company: { id: "company-id" },
});
```
#### Extended by
- [`EdgeClient`](globals.md#edgeclient)
#### Constructors
##### new ReflagClient()
```ts
new ReflagClient(options: ClientOptions): ReflagClient
```
Creates a new SDK client.
See README for configuration options.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`options`
</td>
<td>
[`ClientOptions`](globals.md#clientoptions)
</td>
<td>
The options for the client or an existing client to clone.
</td>
</tr>
</tbody>
</table>
###### Returns
[`ReflagClient`](globals.md#reflagclient)
###### Throws
An error if the options are invalid.
#### Properties
<table>
<thead>
<tr>
<th>Property</th>
<th>Modifier</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="httpclient-1"></a> `httpClient`
</td>
<td>
`public`
</td>
<td>
[`HttpClient`](globals.md#httpclient-2)
</td>
<td>
‐
</td>
</tr>
<tr>
<td>
<a id="logger-1"></a> `logger`
</td>
<td>
`readonly`
</td>
<td>
[`Logger`](globals.md#logger-2)
</td>
<td>
Gets the logger associated with the client.
</td>
</tr>
</tbody>
</table>
#### Accessors
##### flagOverrides
###### Set Signature
```ts
set flagOverrides(overrides:
| Partial<Record<string, FlagOverride>>
| FlagOverridesFn): void
```
Sets the flag overrides.
###### Remarks
The flag overrides are used to override the flag definitions.
This is useful for testing or development.
###### Example
```ts
client.flagOverrides = {
"flag-1": true,
"flag-2": false,
};
```
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`overrides`
</td>
<td>
\| [`Partial`](https://www.typescriptlang.org/docs/handbook/utility-types.html#partialtype)\<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`FlagOverride`](globals.md#flagoverride)\>\> \| [`FlagOverridesFn`](globals.md#flagoverridesfn)
</td>
<td>
The flag overrides.
</td>
</tr>
</tbody>
</table>
###### Returns
`void`
#### Methods
##### bindClient()
```ts
bindClient(context: ContextWithTracking): BoundReflagClient
```
Returns a new BoundReflagClient with the user/company/otherContext
set to be used in subsequent calls.
For example, for evaluating flag targeting or tracking events.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`context`
</td>
<td>
[`ContextWithTracking`](globals.md#contextwithtracking)
</td>
<td>
The context to bind the client to.
</td>
</tr>
</tbody>
</table>
###### Returns
[`BoundReflagClient`](globals.md#boundreflagclient)
A new client bound with the arguments given.
###### Throws
An error if the user/company is given but their ID is not a string.
###### Remarks
The `updateUser` / `updateCompany` methods will automatically be called when
the user/company is set respectively.
##### clearFlagOverrides()
```ts
clearFlagOverrides(): void
```
Clears the flag overrides.
###### Returns
`void`
###### Remarks
This is useful for testing or development.
###### Example
```ts
afterAll(() => {
client.clearFlagOverrides();
});
```
##### destroy()
```ts
destroy(): void
```
Destroys the client and cleans up all resources including timers and background processes.
###### Returns
`void`
###### Remarks
After calling this method, the client should not be used anymore.
This is particularly useful in development environments with hot reloading to prevent
multiple background processes from running simultaneously.
##### flush()
```ts
flush(): Promise<void>
```
Flushes and completes any in-flight fetches in the flag cache.
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Remarks
It is recommended to call this method when the application is shutting down to ensure all events are sent
before the process exits.
This method is automatically called when the process exits if `batchOptions.flushOnExit` is `true` in the options (default).
##### getFlag()
```ts
getFlag<TKey>(__namedParameters: ContextWithTracking, key: TKey): Flag
```
Gets the evaluated flag for the current context which includes the user, company, and custom context.
Using the `isEnabled` property sends a `check` event to Reflag.
###### Type Parameters
<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`TKey` *extends* `string`
</td>
</tr>
</tbody>
</table>
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`__namedParameters`
</td>
<td>
[`ContextWithTracking`](globals.md#contextwithtracking)
</td>
<td>
‐
</td>
</tr>
<tr>
<td>
`key`
</td>
<td>
`TKey`
</td>
<td>
The key of the flag to get.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Flag`](globals.md#flagtconfig)
The evaluated flag.
###### Remarks
Call `initialize` before calling this method to ensure the flag definitions are cached, no flags will be returned otherwise.
##### getFlagDefinitions()
```ts
getFlagDefinitions(): FlagDefinition[]
```
Gets the flag definitions, including all config values.
To evaluate which flags are enabled for a given user/company, use `getFlags`.
###### Returns
[`FlagDefinition`](globals.md#flagdefinition)[]
The flags definitions.
##### getFlagRemote()
```ts
getFlagRemote<TKey>(
key: TKey,
userId?: IdType,
companyId?: IdType,
additionalContext?: Context): Promise<Flag>
```
Gets evaluated flag with the usage of remote context.
This method triggers a network request every time it's called.
###### Type Parameters
<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`TKey` *extends* `string`
</td>
</tr>
</tbody>
</table>
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`key`
</td>
<td>
`TKey`
</td>
<td>
The key of the flag to get.
</td>
</tr>
<tr>
<td>
`userId`?
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The userId of the user to get the flag for.
</td>
</tr>
<tr>
<td>
`companyId`?
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The companyId of the company to get the flag for.
</td>
</tr>
<tr>
<td>
`additionalContext`?
</td>
<td>
[`Context`](globals.md#context-1)
</td>
<td>
The additional context to get the flag for.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Flag`](globals.md#flagtconfig)\>
evaluated flag
##### getFlags()
```ts
getFlags(options: ContextWithTracking): Record<string, Flag>
```
Gets the evaluated flags for the current context which includes the user, company, and custom context.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`options`
</td>
<td>
[`ContextWithTracking`](globals.md#contextwithtracking)
</td>
<td>
The options for the context.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`Flag`](globals.md#flagtconfig)\>
The evaluated flags.
###### Remarks
Call `initialize` before calling this method to ensure the flag definitions are cached, no flags will be returned otherwise.
##### getFlagsForBootstrap()
```ts
getFlagsForBootstrap(options: ContextWithTracking): BootstrappedFlags
```
Gets the evaluated flags for the current context without wrapping them in getters.
This method returns raw flag data suitable for bootstrapping client-side applications.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`options`
</td>
<td>
[`ContextWithTracking`](globals.md#contextwithtracking)
</td>
<td>
The options for the context.
</td>
</tr>
</tbody>
</table>
###### Returns
[`BootstrappedFlags`](globals.md#bootstrappedflags)
The evaluated raw flags and the context.
###### Remarks
Call `initialize` before calling this method to ensure the flag definitions are cached, no flags will be returned otherwise.
This method returns RawFlag objects without wrapping them in getters, making them suitable for serialization.
##### getFlagsRemote()
```ts
getFlagsRemote(
userId?: IdType,
companyId?: IdType,
additionalContext?: Context): Promise<Record<string, Flag>>
```
Gets evaluated flags with the usage of remote context.
This method triggers a network request every time it's called.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`userId`?
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The userId of the user to get the flags for.
</td>
</tr>
<tr>
<td>
`companyId`?
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The companyId of the company to get the flags for.
</td>
</tr>
<tr>
<td>
`additionalContext`?
</td>
<td>
[`Context`](globals.md#context-1)
</td>
<td>
The additional context to get the flags for.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, [`Flag`](globals.md#flagtconfig)\>\>
evaluated flags
##### initialize()
```ts
initialize(): Promise<void>
```
Initializes the client by caching the flags definitions.
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Remarks
Call this method before calling `getFlags` to ensure the flag definitions are cached.
The client will ignore subsequent calls to this method.
##### track()
```ts
track(
userId: IdType,
event: string,
options?: TrackOptions & {
companyId: IdType;
}): Promise<void>
```
Tracks an event in Reflag.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`userId`
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
</tr>
<tr>
<td>
`event`
</td>
<td>
`string`
</td>
</tr>
<tr>
<td>
`options`?
</td>
<td>
[`TrackOptions`](globals.md#trackoptions) & \{ `companyId`: [`IdType`](globals.md#idtype); \}
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Throws
An error if the user is not set or the event is invalid or the options are invalid.
###### Remarks
If the company is set, the event will be associated with the company.
##### updateCompany()
```ts
updateCompany(companyId: IdType, options?: TrackOptions & {
userId: IdType;
}): Promise<void>
```
Updates the associated company in Reflag.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`companyId`
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The companyId of the company to update.
</td>
</tr>
<tr>
<td>
`options`?
</td>
<td>
[`TrackOptions`](globals.md#trackoptions) & \{ `userId`: [`IdType`](globals.md#idtype); \}
</td>
<td>
The options for the company.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Throws
An error if the company is not set or the options are invalid.
###### Remarks
The company must be set using `withCompany` before calling this method.
If the user is set, the company will be associated with the user.
##### updateUser()
```ts
updateUser(userId: IdType, options?: TrackOptions): Promise<void>
```
Updates the associated user in Reflag.
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`userId`
</td>
<td>
[`IdType`](globals.md#idtype)
</td>
<td>
The userId of the user to update.
</td>
</tr>
<tr>
<td>
`options`?
</td>
<td>
[`TrackOptions`](globals.md#trackoptions)
</td>
<td>
The options for the user.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
###### Throws
An error if the company is not set or the options are invalid.
###### Remarks
The company must be set using `withCompany` before calling this method.
If the user is set, the company will be associated with the user.
## Interfaces
### ContextWithTracking
A context with tracking option.
#### Extends
- [`Context`](globals.md#context-1)
#### Properties
<table>
<thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="company-1"></a> `company?`
</td>
<td>
\{ `[k: string]`: `any`; `avatar`: `string`; `id`: `undefined` \| `string` \| `number`; `name`: `string`; \}
</td>
<td>
The company context. If no `id` key is set, the whole object is ignored.
</td>
</tr>
<tr>
<td>
`company.avatar?`
</td>
<td>
`string`
</td>
<td>
The avatar URL of the company.
</td>
</tr>
<tr>
<td>
`company.id`
</td>
<td>
`undefined` \| `string` \| `number`
</td>
<td>
The identifier of the company.
</td>
</tr>
<tr>
<td>
`company.name?`
</td>
<td>
`string`
</td>
<td>
The name of the company.
</td>
</tr>
<tr>
<td>
<a id="enabletracking"></a> `enableTracking?`
</td>
<td>
`boolean`
</td>
<td>
Enable tracking for the context.
If set to `false`, tracking will be disabled for the context. Default is `true`.
</td>
</tr>
<tr>
<td>
<a id="meta"></a> `meta?`
</td>
<td>
[`TrackingMeta`](globals.md#trackingmeta)
</td>
<td>
The meta context used to update the user or company when syncing is required during
feature retrieval.
</td>
</tr>
<tr>
<td>
<a id="other"></a> `other?`
</td>
<td>
[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>
</td>
<td>
The other context. This is used for any additional context that is not related to user or company.
</td>
</tr>
<tr>
<td>
<a id="user-1"></a> `user?`
</td>
<td>
\{ `[k: string]`: `any`; `avatar`: `string`; `email`: `string`; `id`: `undefined` \| `string` \| `number`; `name`: `string`; \}
</td>
<td>
The user context. If no `id` key is set, the whole object is ignored.
</td>
</tr>
<tr>
<td>
`user.avatar?`
</td>
<td>
`string`
</td>
<td>
The avatar URL of the user.
</td>
</tr>
<tr>
<td>
`user.email?`
</td>
<td>
`string`
</td>
<td>
The email of the user.
</td>
</tr>
<tr>
<td>
`user.id`
</td>
<td>
`undefined` \| `string` \| `number`
</td>
<td>
The identifier of the user.
</td>
</tr>
<tr>
<td>
`user.name?`
</td>
<td>
`string`
</td>
<td>
The name of the user.
</td>
</tr>
</tbody>
</table>
***
### Flag\<TConfig\>
Describes a feature
#### Type Parameters
<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Default type</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`TConfig` *extends* [`FlagType`](globals.md#flagtype)\[`"config"`\]
</td>
<td>
[`EmptyFlagRemoteConfig`](globals.md#emptyflagremoteconfig)
</td>
</tr>
</tbody>
</table>
#### Properties
<table>
<thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="config"></a> `config`
</td>
<td>
\| [`EmptyFlagRemoteConfig`](globals.md#emptyflagremoteconfig) \| \{ `key`: `string`; \} & `TConfig`
</td>
<td>
‐
</td>
</tr>
<tr>
<td>
<a id="isenabled"></a> `isEnabled`
</td>
<td>
`boolean`
</td>
<td>
If the feature is enabled.
</td>
</tr>
<tr>
<td>
<a id="key"></a> `key`
</td>
<td>
`string`
</td>
<td>
The key of the feature.
</td>
</tr>
</tbody>
</table>
#### Methods
##### track()
```ts
track(): Promise<void>
```
Track feature usage in Reflag.
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
***
### Flags
Describes a collection of evaluated features.
#### Remarks
You should extend the Flags interface to define the available features.
***
### HttpClient
Defines the interface for an HTTP client.
#### Remarks
This interface is used to abstract the HTTP client implementation from the SDK.
Define your own implementation of this interface to use a different HTTP client.
#### Methods
##### get()
```ts
get<TResponse>(
url: string,
headers: Record<string, string>,
timeoutMs: number): Promise<HttpClientResponse<TResponse>>
```
Sends a GET request to the specified URL.
###### Type Parameters
<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`TResponse`
</td>
</tr>
</tbody>
</table>
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`url`
</td>
<td>
`string`
</td>
<td>
The URL to send the request to.
</td>
</tr>
<tr>
<td>
`headers`
</td>
<td>
[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>
</td>
<td>
The headers to include in the request.
</td>
</tr>
<tr>
<td>
`timeoutMs`
</td>
<td>
`number`
</td>
<td>
‐
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`HttpClientResponse`](globals.md#httpclientresponsetresponse)\<`TResponse`\>\>
The response from the server.
##### post()
```ts
post<TBody, TResponse>(
url: string,
headers: Record<string, string>,
body: TBody): Promise<HttpClientResponse<TResponse>>
```
Sends a POST request to the specified URL.
###### Type Parameters
<table>
<thead>
<tr>
<th>Type Parameter</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`TBody`
</td>
</tr>
<tr>
<td>
`TResponse`
</td>
</tr>
</tbody>
</table>
###### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`url`
</td>
<td>
`string`
</td>
<td>
The URL to send the request to.
</td>
</tr>
<tr>
<td>
`headers`
</td>
<td>
[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `string`\>
</td>
<td>
The headers to include in the request.
</td>
</tr>
<tr>
<td>
`body`
</td>
<td>
`TBody`
</td>
<td>
The body of the request.
</td>
</tr>
</tbody>
</table>
###### Returns
[`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<[`HttpClientResponse`](globals.md#httpclientresponsetresponse)\<`TResponse`\>\>
The response from the server.
***
### Logger
Logger interface for logging messages
#### Properties
<table>
<thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="debug"></a> `debug`
</td>
<td>
(`message`: `string`, `data`?: `any`) => `void`
</td>
<td>
Log a debug messages
</td>
</tr>
<tr>
<td>
<a id="error"></a> `error`
</td>
<td>
(`message`: `string`, `data`?: `any`) => `void`
</td>
<td>
Log an error messages
</td>
</tr>
<tr>
<td>
<a id="info"></a> `info`
</td>
<td>
(`message`: `string`, `data`?: `any`) => `void`
</td>
<td>
Log an info messages
</td>
</tr>
<tr>
<td>
<a id="warn"></a> `warn`
</td>
<td>
(`message`: `string`, `data`?: `any`) => `void`
</td>
<td>
Log a warning messages
</td>
</tr>
</tbody>
</table>
***
### RawFlag
Describes a feature.
#### Properties
<table>
<thead>
<tr>
<th>Property</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="config-1"></a> `config?`
</td>
<td>
[`RawFlagRemoteConfig`](globals.md#rawflagremoteconfig)
</td>
<td>
The remote configuration value for the feature.
</td>
</tr>
<tr>
<td>
<a id="isenabled-1"></a> `isEnabled`
</td>
<td>
`boolean`
</td>
<td>
If the feature is enabled.
</td>
</tr>
<tr>
<td>
<a id="key-1"></a> `key`
</td>
<td>
`string`
</td>
<td>
The key of the feature.
</td>
</tr>
<tr>
<td>
<a id="missingcontextfields"></a> `missingContextFields?`
</td>
<td>
`string`[]
</td>
<td>
The missing fields in the evaluation context (optional).
</td>
</tr>
<tr>
<td>
<a id="ruleevaluationresults"></a> `ruleEvaluationResults?`
</td>
<td>
`boolean`[]
</td>
<td>
The rule results of the evaluation (optional).
</td>
</tr>
<tr>
<td>
<a id="targetingversion"></a> `targetingVersion?`
</td>
<td>
`number`
</td>
<td>
The version of the targeting used to evaluate if the feature is enabled (optional).
</td>
</tr>
</tbody>
</table>
## Type Aliases
### Attributes
```ts
type Attributes = Record<string, any>;
```
Describes the attributes of a user, company or event.
***
### BatchBufferOptions\<T\>
```ts
type BatchBufferOptions<T> = {
flushHandler: (items: T[]) => Promise<void>;
flushOnExit: boolean;
intervalMs: number;
logger: Logger;
maxSize: number;
};
```
Options for configuring the BatchBuffer.
#### Type Parameters
<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`T`
</td>
<td>
The type of items in the buffer.
</td>
</tr>
</tbody>
</table>
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="flushhandler"></a> `flushHandler`
</td>
<td>
(`items`: `T`[]) => [`Promise`](https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Promise)\<`void`\>
</td>
<td>
A function that handles flushing the items in the buffer.
</td>
</tr>
<tr>
<td>
<a id="flushonexit"></a> `flushOnExit`?
</td>
<td>
`boolean`
</td>
<td>
Whether to flush the buffer on exit.
</td>
</tr>
<tr>
<td>
<a id="intervalms"></a> `intervalMs`?
</td>
<td>
`number`
</td>
<td>
The interval in milliseconds at which the buffer is flushed.
**Remarks**
If `0`, the buffer is flushed only when `maxSize` is reached.
</td>
</tr>
<tr>
<td>
<a id="logger-3"></a> `logger`?
</td>
<td>
[`Logger`](globals.md#logger-2)
</td>
<td>
The logger to use for logging (optional).
</td>
</tr>
<tr>
<td>
<a id="maxsize"></a> `maxSize`?
</td>
<td>
`number`
</td>
<td>
The maximum size of the buffer before it is flushed.
</td>
</tr>
</tbody>
</table>
***
### BootstrappedFlags
```ts
type BootstrappedFlags = {
context: Context;
flags: RawFlags;
};
```
Describes a collection of evaluated raw flags and the context for bootstrapping.
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="context"></a> `context`
</td>
<td>
[`Context`](globals.md#context-1)
</td>
</tr>
<tr>
<td>
<a id="flags-1"></a> `flags`
</td>
<td>
[`RawFlags`](globals.md#rawflags)
</td>
</tr>
</tbody>
</table>
***
### CacheStrategy
```ts
type CacheStrategy = "periodically-update" | "in-request";
```
***
### ClientOptions
```ts
type ClientOptions = {
apiBaseUrl: string;
batchOptions: Omit<BatchBufferOptions<any>, "flushHandler" | "logger">;
cacheStrategy: CacheStrategy;
configFile: string;
emitEvaluationEvents: boolean;
fallbackFlags: | TypedFlagKey[]
| Record<TypedFlagKey, Exclude<FlagOverride, false>>;
fetchTimeoutMs: number;
flagOverrides: | string
| (context: Context) => FlagOverrides;
flagsFetchRetries: number;
host: string;
httpClient: HttpClient;
logger: Logger;
logLevel: LogLevel;
offline: boolean;
secretKey: string;
};
```
Defines the options for the SDK client.
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="apibaseurl"></a> `apiBaseUrl`?
</td>
<td>
`string`
</td>
<td>
The host to send requests to (optional).
</td>
</tr>
<tr>
<td>
<a id="batchoptions"></a> `batchOptions`?
</td>
<td>
[`Omit`](https://www.typescriptlang.org/docs/handbook/utility-types.html#omittype-keys)\<[`BatchBufferOptions`](globals.md#batchbufferoptionst)\<`any`\>, `"flushHandler"` \| `"logger"`\>
</td>
<td>
The options for the batch buffer (optional).
If not provided, the default options are used.
</td>
</tr>
<tr>
<td>
<a id="cachestrategy-1"></a> `cacheStrategy`?
</td>
<td>
[`CacheStrategy`](globals.md#cachestrategy)
</td>
<td>
The cache strategy to use for the client (optional, defaults to "periodically-update").
</td>
</tr>
<tr>
<td>
<a id="configfile"></a> `configFile`?
</td>
<td>
`string`
</td>
<td>
The path to the config file. If supplied, the config file will be loaded.
Defaults to `reflag.config.json` when NODE_ENV is not production. Can also be
set through the environment variable REFLAG_CONFIG_FILE.
</td>
</tr>
<tr>
<td>
<a id="emitevaluationevents"></a> `emitEvaluationEvents`?
</td>
<td>
`boolean`
</td>
<td>
If set to `false`, no evaluation events will be emitted.
</td>
</tr>
<tr>
<td>
<a id="fallbackflags"></a> `fallbackFlags`?
</td>
<td>
\| [`TypedFlagKey`](globals.md#typedflagkey)[]
\| [`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<[`TypedFlagKey`](globals.md#typedflagkey), [`Exclude`](https://www.typescriptlang.org/docs/handbook/utility-types.html#excludeuniontype-excludedmembers)\<[`FlagOverride`](globals.md#flagoverride), `false`\>\>
</td>
<td>
The features to "enable" as fallbacks when the API is unavailable (optional).
Can be an array of feature keys, or a record of feature keys and boolean or object values.
If a record is supplied instead of array, the values of each key are either the
configuration values or the boolean value `true`.
</td>
</tr>
<tr>
<td>
<a id="fetchtimeoutms"></a> `fetchTimeoutMs`?
</td>
<td>
`number`
</td>
<td>
The timeout in milliseconds for fetching feature targeting data (optional).
Default is 10000 ms.
</td>
</tr>
<tr>
<td>
<a id="flagoverrides-2"></a> `flagOverrides`?
</td>
<td>
\| `string`
\| (`context`: [`Context`](globals.md#context-1)) => [`FlagOverrides`](globals.md#flagoverrides-3)
</td>
<td>
If a filename is specified, feature targeting results be overridden with
the values from this file. The file should be a JSON object with flag
keys as keys, and boolean or object as values.
If a function is specified, the function will be called with the context
and should return a record of flag keys and boolean or object values.
Defaults to "reflagFlags.json".
</td>
</tr>
<tr>
<td>
<a id="flagsfetchretries"></a> `flagsFetchRetries`?
</td>
<td>
`number`
</td>
<td>
Number of times to retry fetching feature definitions (optional).
Default is 3 times.
</td>
</tr>
<tr>
<td>
<a id="host"></a> `host`?
</td>
<td>
`string`
</td>
<td>
**Deprecated**
Use `apiBaseUrl` instead.
</td>
</tr>
<tr>
<td>
<a id="httpclient-3"></a> `httpClient`?
</td>
<td>
[`HttpClient`](globals.md#httpclient-2)
</td>
<td>
The HTTP client to use for sending requests (optional). Default is the built-in fetch client.
</td>
</tr>
<tr>
<td>
<a id="logger-4"></a> `logger`?
</td>
<td>
[`Logger`](globals.md#logger-2)
</td>
<td>
The logger to use for logging (optional). Default is info level logging to console.
</td>
</tr>
<tr>
<td>
<a id="loglevel"></a> `logLevel`?
</td>
<td>
[`LogLevel`](globals.md#loglevel-1)
</td>
<td>
Use the console logger, but set a log level. Ineffective if a custom logger is provided.
</td>
</tr>
<tr>
<td>
<a id="offline"></a> `offline`?
</td>
<td>
`boolean`
</td>
<td>
In offline mode, no data is sent or fetched from the the Reflag API.
This is useful for testing or development.
</td>
</tr>
<tr>
<td>
<a id="secretkey"></a> `secretKey`?
</td>
<td>
`string`
</td>
<td>
The secret key used to authenticate with the Reflag API.
</td>
</tr>
</tbody>
</table>
***
### Context
```ts
type Context = {
company: {
[k: string]: any; avatar: string;
id: string | number | undefined;
name: string;
};
other: Record<string, any>;
user: {
[k: string]: any; avatar: string;
email: string;
id: string | number | undefined;
name: string;
};
};
```
Describes the current user context, company context, and other context.
This is used to determine if feature targeting matches and to track events.
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="company-2"></a> `company`?
</td>
<td>
\{
`[k: string]`: `any`; `avatar`: `string`;
`id`: `string` \| `number` \| `undefined`;
`name`: `string`;
\}
</td>
<td>
The company context. If no `id` key is set, the whole object is ignored.
</td>
</tr>
<tr>
<td>
`company.avatar`?
</td>
<td>
`string`
</td>
<td>
The avatar URL of the company.
</td>
</tr>
<tr>
<td>
`company.id`
</td>
<td>
`string` \| `number` \| `undefined`
</td>
<td>
The identifier of the company.
</td>
</tr>
<tr>
<td>
`company.name`?
</td>
<td>
`string`
</td>
<td>
The name of the company.
</td>
</tr>
<tr>
<td>
<a id="other-1"></a> `other`?
</td>
<td>
[`Record`](https://www.typescriptlang.org/docs/handbook/utility-types.html#recordkeys-type)\<`string`, `any`\>
</td>
<td>
The other context. This is used for any additional context that is not related to user or company.
</td>
</tr>
<tr>
<td>
<a id="user-2"></a> `user`?
</td>
<td>
\{
`[k: string]`: `any`; `avatar`: `string`;
`email`: `string`;
`id`: `string` \| `number` \| `undefined`;
`name`: `string`;
\}
</td>
<td>
The user context. If no `id` key is set, the whole object is ignored.
</td>
</tr>
<tr>
<td>
`user.avatar`?
</td>
<td>
`string`
</td>
<td>
The avatar URL of the user.
</td>
</tr>
<tr>
<td>
`user.email`?
</td>
<td>
`string`
</td>
<td>
The email of the user.
</td>
</tr>
<tr>
<td>
`user.id`
</td>
<td>
`string` \| `number` \| `undefined`
</td>
<td>
The identifier of the user.
</td>
</tr>
<tr>
<td>
`user.name`?
</td>
<td>
`string`
</td>
<td>
The name of the user.
</td>
</tr>
</tbody>
</table>
***
### EdgeClientOptions
```ts
type EdgeClientOptions = Omit<ClientOptions, "cacheStrategy" | "flushIntervalMs" | "batchOptions">;
```
***
### EmptyFlagRemoteConfig
```ts
type EmptyFlagRemoteConfig = {
key: undefined;
payload: undefined;
};
```
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="key-2"></a> `key`
</td>
<td>
`undefined`
</td>
</tr>
<tr>
<td>
<a id="payload"></a> `payload`
</td>
<td>
`undefined`
</td>
</tr>
</tbody>
</table>
***
### FlagConfigVariant
```ts
type FlagConfigVariant = {
filter: RuleFilter;
key: string;
payload: any;
};
```
Describes a remote feature config variant.
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="filter"></a> `filter`
</td>
<td>
`RuleFilter`
</td>
<td>
The filter for the variant.
</td>
</tr>
<tr>
<td>
<a id="key-3"></a> `key`
</td>
<td>
`string`
</td>
<td>
The key of the variant.
</td>
</tr>
<tr>
<td>
<a id="payload-1"></a> `payload`
</td>
<td>
`any`
</td>
<td>
The optional user-supplied payload data.
</td>
</tr>
</tbody>
</table>
***
### FlagDefinition
```ts
type FlagDefinition = {
config: {
variants: FlagConfigVariant[];
version: number;
};
description: string | null;
flag: {
rules: {
filter: RuleFilter;
}[];
version: number;
};
key: string;
};
```
Describes a feature definition.
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="config-2"></a> `config`?
</td>
<td>
\{
`variants`: [`FlagConfigVariant`](globals.md#flagconfigvariant)[];
`version`: `number`;
\}
</td>
<td>
The remote configuration for the feature.
</td>
</tr>
<tr>
<td>
`config.variants`
</td>
<td>
[`FlagConfigVariant`](globals.md#flagconfigvariant)[]
</td>
<td>
The variants of the remote configuration.
</td>
</tr>
<tr>
<td>
`config.version`
</td>
<td>
`number`
</td>
<td>
The version of the remote configuration.
</td>
</tr>
<tr>
<td>
<a id="description"></a> `description`
</td>
<td>
`string` \| `null`
</td>
<td>
Description of the feature.
</td>
</tr>
<tr>
<td>
<a id="flag"></a> `flag`
</td>
<td>
\{
`rules`: \{
`filter`: `RuleFilter`;
\}[];
`version`: `number`;
\}
</td>
<td>
The targeting rules for the feature.
</td>
</tr>
<tr>
<td>
`flag.rules`
</td>
<td>
\{
`filter`: `RuleFilter`;
\}[]
</td>
<td>
The targeting rules.
</td>
</tr>
<tr>
<td>
`flag.version`
</td>
<td>
`number`
</td>
<td>
The version of the targeting rules.
</td>
</tr>
<tr>
<td>
<a id="key-4"></a> `key`
</td>
<td>
`string`
</td>
<td>
The key of the feature.
</td>
</tr>
</tbody>
</table>
***
### FlagOverride
```ts
type FlagOverride =
| FlagType & {
config: {
key: string;
};
isEnabled: boolean;
}
| boolean;
```
***
### FlagOverrides
```ts
type FlagOverrides = Partial<keyof Flags extends never ? Record<string, FlagOverride> : { [FlagKey in keyof Flags]: Flags[FlagKey] extends FlagOverride ? Flags[FlagKey] : Exclude<FlagOverride, "config"> }>;
```
Describes the feature overrides.
***
### FlagOverridesFn()
```ts
type FlagOverridesFn = (context: Context) => FlagOverrides;
```
#### Parameters
<table>
<thead>
<tr>
<th>Parameter</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`context`
</td>
<td>
[`Context`](globals.md#context-1)
</td>
</tr>
</tbody>
</table>
#### Returns
[`FlagOverrides`](globals.md#flagoverrides-3)
***
### FlagRemoteConfig
```ts
type FlagRemoteConfig =
| {
key: string;
payload: any;
}
| EmptyFlagRemoteConfig;
```
A remotely managed configuration value for a feature.
#### Type declaration
\{
`key`: `string`;
`payload`: `any`;
\}
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`key`
</td>
<td>
`string`
</td>
<td>
The key of the matched configuration value.
</td>
</tr>
<tr>
<td>
`payload`
</td>
<td>
`any`
</td>
<td>
The optional user-supplied payload data.
</td>
</tr>
</tbody>
</table>
[`EmptyFlagRemoteConfig`](globals.md#emptyflagremoteconfig)
***
### FlagType
```ts
type FlagType = {
config: {
payload: any;
};
};
```
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="config-3"></a> `config`?
</td>
<td>
\{
`payload`: `any`;
\}
</td>
</tr>
<tr>
<td>
`config.payload`
</td>
<td>
`any`
</td>
</tr>
</tbody>
</table>
***
### HttpClientResponse\<TResponse\>
```ts
type HttpClientResponse<TResponse> = {
body: TResponse | undefined;
ok: boolean;
status: number;
};
```
Describes the response of a HTTP client.
#### Type Parameters
<table>
<thead>
<tr>
<th>Type Parameter</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
`TResponse`
</td>
<td>
The type of the response body.
</td>
</tr>
</tbody>
</table>
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="body"></a> `body`
</td>
<td>
`TResponse` \| `undefined`
</td>
<td>
The body of the response if available.
</td>
</tr>
<tr>
<td>
<a id="ok"></a> `ok`
</td>
<td>
`boolean`
</td>
<td>
Indicates that the request succeeded.
</td>
</tr>
<tr>
<td>
<a id="status"></a> `status`
</td>
<td>
`number`
</td>
<td>
The status code of the response.
</td>
</tr>
</tbody>
</table>
***
### IdType
```ts
type IdType = string | number;
```
***
### LogLevel
```ts
type LogLevel = typeof LOG_LEVELS[number];
```
***
### RawFlagRemoteConfig
```ts
type RawFlagRemoteConfig = {
key: string;
missingContextFields: string[];
payload: any;
ruleEvaluationResults: boolean[];
targetingVersion: number;
};
```
A remotely managed configuration value for a feature.
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="key-5"></a> `key`
</td>
<td>
`string`
</td>
<td>
The key of the matched configuration value.
</td>
</tr>
<tr>
<td>
<a id="missingcontextfields-1"></a> `missingContextFields`?
</td>
<td>
`string`[]
</td>
<td>
The missing fields in the evaluation context (optional).
</td>
</tr>
<tr>
<td>
<a id="payload-2"></a> `payload`
</td>
<td>
`any`
</td>
<td>
The optional user-supplied payload data.
</td>
</tr>
<tr>
<td>
<a id="ruleevaluationresults-1"></a> `ruleEvaluationResults`?
</td>
<td>
`boolean`[]
</td>
<td>
The rule results of the evaluation (optional).
</td>
</tr>
<tr>
<td>
<a id="targetingversion-1"></a> `targetingVersion`?
</td>
<td>
`number`
</td>
<td>
The version of the targeting rules used to select the config value.
</td>
</tr>
</tbody>
</table>
***
### RawFlags
```ts
type RawFlags = Record<TypedFlagKey, RawFlag>;
```
Describes a collection of evaluated raw flags.
***
### TrackingMeta
```ts
type TrackingMeta = {
active: boolean;
};
```
Describes the meta context associated with tracking.
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="active"></a> `active`?
</td>
<td>
`boolean`
</td>
<td>
Whether the user or company is active.
</td>
</tr>
</tbody>
</table>
***
### TrackOptions
```ts
type TrackOptions = {
attributes: Attributes;
meta: TrackingMeta;
};
```
Defines the options for tracking of entities.
#### Type declaration
<table>
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<td>
<a id="attributes-1"></a> `attributes`?
</td>
<td>
[`Attributes`](globals.md#attributes)
</td>
<td>
The attributes associated with the event.
</td>
</tr>
<tr>
<td>
<a id="meta-1"></a> `meta`?
</td>
<td>
[`TrackingMeta`](globals.md#trackingmeta)
</td>
<td>
The meta context associated with the event.
</td>
</tr>
</tbody>
</table>
***
### TypedFlagKey
```ts
type TypedFlagKey = keyof TypedFlags;
```
***
### TypedFlags
```ts
type TypedFlags = keyof Flags extends never ? Record<string, Flag> : { [FlagKey in keyof Flags]: Flags[FlagKey] extends FlagType ? Flag<Flags[FlagKey]["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.
## Variables
### LOG\_LEVELS
```ts
const LOG_LEVELS: readonly ["DEBUG", "INFO", "WARN", "ERROR"];
```
```
