Skip to content

docs: Document the overrideAffected flag metadata key in the OpenFeature Node.js provider README #2111

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Draft
kinyoklion wants to merge 1 commit into
base: main
Choose a base branch
from
+9 −8
Draft

docs: Document the overrideAffected flag metadata key in the OpenFeature Node.js provider README #2111

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 9 additions & 8 deletions packages/sdk/openfeature-node-server/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -110,14 +110,15 @@ There are several attributes with special handling within a single or multi-cont

Evaluation results include LaunchDarkly specific information in the OpenFeature flag metadata. A key is only present when it applies to the evaluation.

| Key | Type | Description |
| ------------------- | ------- | ------------------------------------------------------------------------------ |
| `variationIndex` | number | The index of the served variation. Absent when the default value was returned. |
| `inExperiment` | boolean | Present, and `true`, when the evaluation was part of an experiment. |
| `ruleIndex` | number | The index of the matched rule, for a `RULE_MATCH` reason. |
| `ruleId` | string | The identifier of the matched rule, for a `RULE_MATCH` reason. |
| `prerequisiteKey` | string | The key of the failed prerequisite flag, for a `PREREQUISITE_FAILED` reason. |
| `bigSegmentsStatus` | string | The status of the Big Segment query, when the evaluation required one. |
| Key | Type | Description |
| ------------------- | ------- | ----------------------------------------------------------------------------------------------------------------------- |
| `variationIndex` | number | The index of the served variation. Absent when the default value was returned. |
| `inExperiment` | boolean | Present, and `true`, when the evaluation was part of an experiment. |
| `ruleIndex` | number | The index of the matched rule, for a `RULE_MATCH` reason. |
| `ruleId` | string | The identifier of the matched rule, for a `RULE_MATCH` reason. |
| `prerequisiteKey` | string | The key of the failed prerequisite flag, for a `PREREQUISITE_FAILED` reason. |
| `bigSegmentsStatus` | string | The status of the Big Segment query, when the evaluation required one. |
| `overrideAffected` | boolean | Present, and `true`, when the evaluation read a flag or segment definition supplied by an experimental override source. |

```typescript
const details = await client.getBooleanDetails('my-boolean-flag', false);
Expand Down
Loading