Skip to content

Commit c68056f

Browse files
openfeaturebotopenfeaturebot
committed
chore: update sdk readmes
Signed-off-by: OpenFeature Bot <109696520+openfeaturebot@users.noreply.github.com>
1 parent 85b068c commit c68056f

15 files changed

Lines changed: 54 additions & 18 deletions

File tree

‎docs/reference/sdks/client/kotlin.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from kotlin-sdk.
1010
Edits should be made here: https://github.com/open-feature/kotlin-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Fri Mar 27 2026 08:23:35 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 01 2026 08:36:55 GMT+0000 (Coordinated Universal Time)
1414
-->
1515
import MCPInstall from '@site/src/partials/mcp-install';
1616

‎docs/reference/sdks/client/swift.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from swift-sdk.
1010
Edits should be made here: https://github.com/open-feature/swift-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Fri Mar 27 2026 08:23:36 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 01 2026 08:36:56 GMT+0000 (Coordinated Universal Time)
1414
-->
1515
import MCPInstall from '@site/src/partials/mcp-install';
1616

‎docs/reference/sdks/client/web/angular.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Fri Mar 27 2026 08:23:36 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 01 2026 08:36:56 GMT+0000 (Coordinated Universal Time)
1414
-->
1515

1616
<p align="center" class="github-badges">
@@ -418,6 +418,10 @@ The [OpenFeature debounce hook](https://github.com/open-feature/js-sdk-contrib/t
418418
to reduce the amount of redundant evaluations reported to your observability platform by limiting the frequency at which
419419
evaluation metrics are reported.
420420

421+
#### Type-Safe Flag Keys
422+
423+
For enhanced type safety and autocompletion, you can override flag key types using TypeScript module augmentation. See the [`@openfeature/core` README](https://github.com/open-feature/js-sdk/blob/main/packages/shared/README.md#type-safe-flag-keys) for details.
424+
421425
## FAQ and troubleshooting
422426

423427
> I can import things form the `@openfeature/angular-sdk`, `@openfeature/web-sdk`, and `@openfeature/core`; which should I use?

‎docs/reference/sdks/client/web/index.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Fri Mar 27 2026 08:23:35 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 01 2026 08:36:55 GMT+0000 (Coordinated Universal Time)
1414
-->
1515
import MCPInstall from '@site/src/partials/mcp-install';
1616

@@ -370,6 +370,10 @@ import { OpenFeature } from '@openfeature/web-sdk';
370370
await OpenFeature.close();
371371
```
372372

373+
### Type-Safe Flag Keys
374+
375+
For enhanced type safety and autocompletion, you can override flag key types using TypeScript module augmentation. See the [`@openfeature/core` README](https://github.com/open-feature/js-sdk/blob/main/packages/shared/README.md#type-safe-flag-keys) for details.
376+
373377
## Extending
374378

375379
### Develop a provider

‎docs/reference/sdks/client/web/react.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Fri Mar 27 2026 08:23:35 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 01 2026 08:36:55 GMT+0000 (Coordinated Universal Time)
1414
-->
1515
import MCPInstall from '@site/src/partials/mcp-install';
1616

@@ -371,6 +371,10 @@ React's lifecycle can result in flags being evaluated multiple times as a user i
371371
If you are using an OpenFeature hook for telemetry, this can result in inflated evaluation metrics.
372372
The [OpenFeature debounce hook](https://github.com/open-feature/js-sdk-contrib/tree/main/libs/hooks/debounce) can help to reduce the amount of redundant evaluations reported to your observability platform by limiting the frequency at which evaluation metrics are reported.
373373

374+
#### Type-Safe Flag Keys
375+
376+
For enhanced type safety and autocompletion, you can override flag key types using TypeScript module augmentation. See the [`@openfeature/core` README](https://github.com/open-feature/js-sdk/blob/main/packages/shared/README.md#type-safe-flag-keys) for details.
377+
374378
### Testing
375379

376380
The React SDK includes a built-in context provider for testing.

‎docs/reference/sdks/server/dart.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This content has been automatically generated from dart-server-sdk.
99
Edits should be made here: https://github.com/open-feature/dart-server-sdk
1010
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1111

12-
Last updated at Fri Mar 27 2026 08:23:36 GMT+0000 (Coordinated Universal Time)
12+
Last updated at Wed Apr 01 2026 08:36:56 GMT+0000 (Coordinated Universal Time)
1313
-->
1414

1515
<p align="center" class="github-badges">

‎docs/reference/sdks/server/dotnet.mdx‎

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from dotnet-sdk.
1010
Edits should be made here: https://github.com/open-feature/dotnet-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Fri Mar 27 2026 08:23:35 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 01 2026 08:36:55 GMT+0000 (Coordinated Universal Time)
1414
-->
1515
import MCPInstall from '@site/src/partials/mcp-install';
1616

@@ -89,9 +89,10 @@ public async Task Example()
8989

9090
The [`samples/`](https://github.com/open-feature/dotnet-sdk/blob/main/samples) folder contains example applications demonstrating how to use OpenFeature in different .NET scenarios.
9191

92-
| Sample Name | Description |
93-
| ------------------------------------------- | ----------------------------------------- |
94-
| [AspNetCore](https://github.com/open-feature/dotnet-sdk/blob/main/samples/AspNetCore/README.md) | Feature flags in an ASP.NET Core Web API. |
92+
| Sample Name | Description |
93+
| ----------------------------------------------------- | ----------------------------------------- |
94+
| [AspNetCore](https://github.com/open-feature/dotnet-sdk/blob/main/samples/AspNetCore/README.md) | Feature flags in an ASP.NET Core Web API. |
95+
| [Console](https://github.com/open-feature/dotnet-sdk/blob/main/samples/Console/README.md) | Feature flags in a .NET console app. |
9596

9697
**Getting Started with a Sample:**
9798

‎docs/reference/sdks/server/go.mdx‎

Lines changed: 16 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This content has been automatically generated from go-sdk.
99
Edits should be made here: https://github.com/open-feature/go-sdk
1010
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1111

12-
Last updated at Fri Mar 27 2026 08:23:35 GMT+0000 (Coordinated Universal Time)
12+
Last updated at Wed Apr 01 2026 08:36:55 GMT+0000 (Coordinated Universal Time)
1313
-->
1414
import MCPInstall from '@site/src/partials/mcp-install';
1515

@@ -514,6 +514,21 @@ for name, tt := range tests {
514514
}
515515
```
516516

517+
If your test code runs in a different goroutine, `TestProvider.UsingFlags` returns a context that should be used for evaluations.
518+
519+
You can pass `*testing.T` directly.
520+
521+
```go
522+
// In your test, 't' is a *testing.T
523+
ctx := testProvider.UsingFlags(t, tt.flags)
524+
525+
go func() {
526+
// Make sure to use the context returned by UsingFlags in the new goroutine.
527+
// The context carries the necessary information for the TestProvider.
528+
_ = openfeature.NewDefaultClient().Boolean(ctx, "my_flag", false, openfeature.EvaluationContext{})
529+
}()
530+
```
531+
517532
### Mocks
518533

519534
Mocks are also available for testing purposes for all interfaces within the OpenFeature SDK. These are primarily

‎docs/reference/sdks/server/java.mdx‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ This content has been automatically generated from java-sdk.
99
Edits should be made here: https://github.com/open-feature/java-sdk
1010
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1111

12-
Last updated at Fri Mar 27 2026 08:23:35 GMT+0000 (Coordinated Universal Time)
12+
Last updated at Wed Apr 01 2026 08:36:54 GMT+0000 (Coordinated Universal Time)
1313
-->
1414
import MCPInstall from '@site/src/partials/mcp-install';
1515

‎docs/reference/sdks/server/javascript/index.mdx‎

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ This content has been automatically generated from js-sdk.
1010
Edits should be made here: https://github.com/open-feature/js-sdk
1111
Once a repo has been updated, docs can be generated by running: yarn update:sdk-docs
1212

13-
Last updated at Fri Mar 27 2026 08:23:35 GMT+0000 (Coordinated Universal Time)
13+
Last updated at Wed Apr 01 2026 08:36:55 GMT+0000 (Coordinated Universal Time)
1414
-->
1515
import MCPInstall from '@site/src/partials/mcp-install';
1616

@@ -393,6 +393,10 @@ import { OpenFeature } from '@openfeature/server-sdk';
393393
await OpenFeature.close();
394394
```
395395

396+
### Type-Safe Flag Keys
397+
398+
For enhanced type safety and autocompletion, you can override flag key types using TypeScript module augmentation. See the [`@openfeature/core` README](https://github.com/open-feature/js-sdk/blob/main/packages/shared/README.md#type-safe-flag-keys) for details.
399+
396400
## Extending
397401

398402
### Develop a provider

0 commit comments

Comments
 (0)