Skip to content

Commit 69433d9

Browse files
committed
chore: update readme
1 parent 5b667fb commit 69433d9

3 files changed

Lines changed: 45 additions & 0 deletions

File tree

packages/next/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -174,6 +174,21 @@ export function ConfigDisplay() {
174174
}
175175
```
176176

177+
## Client Options
178+
179+
The `options` prop accepts all options from `@replanejs/sdk`. Key options:
180+
181+
| Option | Type | Required | Description |
182+
| ------------------------- | ---------------------- | -------- | ------------------------------------------ |
183+
| `baseUrl` | `string` | Yes | Replane server URL |
184+
| `sdkKey` | `string` | Yes | SDK key for authentication |
185+
| `context` | `Record<string, any>` | No | Default context for override evaluations |
186+
| `defaults` | `Record<string, any>` | No | Default values if server is unavailable |
187+
| `required` | `string[]` or `object` | No | Configs that must exist for initialization |
188+
| `initializationTimeoutMs` | `number` | No | SDK initialization timeout (default: 5000) |
189+
190+
See [`@replanejs/sdk` documentation](https://github.com/replane-dev/replane-javascript/tree/main/packages/sdk#options) for the complete list of options.
191+
177192
## API Reference
178193

179194
### Components

packages/react/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,21 @@ import { ErrorBoundary } from "react-error-boundary";
7373
</ErrorBoundary>;
7474
```
7575

76+
#### Client Options
77+
78+
The `options` prop accepts all options from `@replanejs/sdk`. Key options:
79+
80+
| Option | Type | Required | Description |
81+
| ------------------------- | ---------------------- | -------- | ------------------------------------------ |
82+
| `baseUrl` | `string` | Yes | Replane server URL |
83+
| `sdkKey` | `string` | Yes | SDK key for authentication |
84+
| `context` | `Record<string, any>` | No | Default context for override evaluations |
85+
| `defaults` | `Record<string, any>` | No | Default values if server is unavailable |
86+
| `required` | `string[]` or `object` | No | Configs that must exist for initialization |
87+
| `initializationTimeoutMs` | `number` | No | SDK initialization timeout (default: 5000) |
88+
89+
See [`@replanejs/sdk` documentation](https://github.com/replane-dev/replane-javascript/tree/main/packages/sdk#options) for the complete list of options.
90+
7691
#### 2. With pre-created client
7792

7893
Use this when you need more control over client lifecycle:

packages/svelte/README.md

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -45,6 +45,21 @@ npm install @replanejs/svelte
4545
{/if}
4646
```
4747

48+
## Client Options
49+
50+
The `options` prop accepts all options from `@replanejs/sdk`. Key options:
51+
52+
| Option | Type | Required | Description |
53+
| ------------------------- | ---------------------- | -------- | ------------------------------------------ |
54+
| `baseUrl` | `string` | Yes | Replane server URL |
55+
| `sdkKey` | `string` | Yes | SDK key for authentication |
56+
| `context` | `Record<string, any>` | No | Default context for override evaluations |
57+
| `defaults` | `Record<string, any>` | No | Default values if server is unavailable |
58+
| `required` | `string[]` or `object` | No | Configs that must exist for initialization |
59+
| `initializationTimeoutMs` | `number` | No | SDK initialization timeout (default: 5000) |
60+
61+
See [`@replanejs/sdk` documentation](https://github.com/replane-dev/replane-javascript/tree/main/packages/sdk#options) for the complete list of options.
62+
4863
## API
4964

5065
### config

0 commit comments

Comments
 (0)