Skip to content

Commit edea33d

Browse files
typottertypotter
authored
chore: update docs (#86)
* chore: update docs
1 parent f61204f commit edea33d

13 files changed

+166
-1
lines changed

‎docs/node-server-sdk.iclientconfig.apikey.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [apiKey](./node-server-sdk.iclientconfig.apikey.md)
4+
5+
## IClientConfig.apiKey property
6+
7+
Eppo SDK key
8+
9+
**Signature:**
10+
11+
```typescript
12+
apiKey: string;
13+
```

‎docs/node-server-sdk.iclientconfig.assignmentlogger.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [assignmentLogger](./node-server-sdk.iclientconfig.assignmentlogger.md)
4+
5+
## IClientConfig.assignmentLogger property
6+
7+
Provide a logging implementation to send variation assignments to your data warehouse.
8+
9+
**Signature:**
10+
11+
```typescript
12+
assignmentLogger: IAssignmentLogger;
13+
```

‎docs/node-server-sdk.iclientconfig.banditlogger.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [banditLogger](./node-server-sdk.iclientconfig.banditlogger.md)
4+
5+
## IClientConfig.banditLogger property
6+
7+
Logging implementation to send bandit actions to your data warehouse
8+
9+
**Signature:**
10+
11+
```typescript
12+
banditLogger?: IBanditLogger;
13+
```

‎docs/node-server-sdk.iclientconfig.baseurl.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [baseUrl](./node-server-sdk.iclientconfig.baseurl.md)
4+
5+
## IClientConfig.baseUrl property
6+
7+
Base URL of the Eppo API. Clients should use the default setting in most cases.
8+
9+
**Signature:**
10+
11+
```typescript
12+
baseUrl?: string;
13+
```

‎docs/node-server-sdk.iclientconfig.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md)
4+
5+
## IClientConfig interface
6+
7+
Configuration used for initializing the Eppo client
8+
9+
**Signature:**
10+
11+
```typescript
12+
export interface IClientConfig
13+
```
14+
15+
## Properties
16+
17+
| Property | Modifiers | Type | Description |
18+
| --- | --- | --- | --- |
19+
| [apiKey](./node-server-sdk.iclientconfig.apikey.md) | | string | Eppo SDK key |
20+
| [assignmentLogger](./node-server-sdk.iclientconfig.assignmentlogger.md) | | IAssignmentLogger | Provide a logging implementation to send variation assignments to your data warehouse. |
21+
| [banditLogger?](./node-server-sdk.iclientconfig.banditlogger.md) | | IBanditLogger | _(Optional)_ Logging implementation to send bandit actions to your data warehouse |
22+
| [baseUrl?](./node-server-sdk.iclientconfig.baseurl.md) | | string | _(Optional)_ Base URL of the Eppo API. Clients should use the default setting in most cases. |
23+
| [numInitialRequestRetries?](./node-server-sdk.iclientconfig.numinitialrequestretries.md) | | number | _(Optional)_ Number of additional times the initial configuration request will be attempted if it fails. This is the request servers typically synchronously wait for completion. A small wait will be done between requests. (Default: 1) |
24+
| [numPollRequestRetries?](./node-server-sdk.iclientconfig.numpollrequestretries.md) | | number | _(Optional)_ Number of additional times polling for updated configurations will be attempted before giving up. Polling is done after a successful initial request. Subsequent attempts are done using an exponential backoff. (Default: 7) |
25+
| [pollAfterFailedInitialization?](./node-server-sdk.iclientconfig.pollafterfailedinitialization.md) | | boolean | _(Optional)_ Poll for new configurations even if the initial configuration request failed. (default: false) |
26+
| [pollingIntervalMs?](./node-server-sdk.iclientconfig.pollingintervalms.md) | | number | _(Optional)_ Amount of time in milliseconds to wait between API calls to refresh configuration data. Default of 30\_000 (30s). |
27+
| [requestTimeoutMs?](./node-server-sdk.iclientconfig.requesttimeoutms.md) | | number | _(Optional)_ Timeout in milliseconds for the HTTPS request for the experiment configuration. (Default: 5000) |
28+
| [throwOnFailedInitialization?](./node-server-sdk.iclientconfig.throwonfailedinitialization.md) | | boolean | _(Optional)_ Throw error if unable to fetch an initial configuration during initialization. (default: true) |
29+

‎docs/node-server-sdk.iclientconfig.numinitialrequestretries.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [numInitialRequestRetries](./node-server-sdk.iclientconfig.numinitialrequestretries.md)
4+
5+
## IClientConfig.numInitialRequestRetries property
6+
7+
Number of additional times the initial configuration request will be attempted if it fails. This is the request servers typically synchronously wait for completion. A small wait will be done between requests. (Default: 1)
8+
9+
**Signature:**
10+
11+
```typescript
12+
numInitialRequestRetries?: number;
13+
```

‎docs/node-server-sdk.iclientconfig.numpollrequestretries.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [numPollRequestRetries](./node-server-sdk.iclientconfig.numpollrequestretries.md)
4+
5+
## IClientConfig.numPollRequestRetries property
6+
7+
Number of additional times polling for updated configurations will be attempted before giving up. Polling is done after a successful initial request. Subsequent attempts are done using an exponential backoff. (Default: 7)
8+
9+
**Signature:**
10+
11+
```typescript
12+
numPollRequestRetries?: number;
13+
```

‎docs/node-server-sdk.iclientconfig.pollafterfailedinitialization.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [pollAfterFailedInitialization](./node-server-sdk.iclientconfig.pollafterfailedinitialization.md)
4+
5+
## IClientConfig.pollAfterFailedInitialization property
6+
7+
Poll for new configurations even if the initial configuration request failed. (default: false)
8+
9+
**Signature:**
10+
11+
```typescript
12+
pollAfterFailedInitialization?: boolean;
13+
```

‎docs/node-server-sdk.iclientconfig.pollingintervalms.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [pollingIntervalMs](./node-server-sdk.iclientconfig.pollingintervalms.md)
4+
5+
## IClientConfig.pollingIntervalMs property
6+
7+
Amount of time in milliseconds to wait between API calls to refresh configuration data. Default of 30\_000 (30s).
8+
9+
**Signature:**
10+
11+
```typescript
12+
pollingIntervalMs?: number;
13+
```

‎docs/node-server-sdk.iclientconfig.requesttimeoutms.md‎

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,13 @@
1+
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
2+
3+
[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [requestTimeoutMs](./node-server-sdk.iclientconfig.requesttimeoutms.md)
4+
5+
## IClientConfig.requestTimeoutMs property
6+
7+
Timeout in milliseconds for the HTTPS request for the experiment configuration. (Default: 5000)
8+
9+
**Signature:**
10+
11+
```typescript
12+
requestTimeoutMs?: number;
13+
```

0 commit comments

Comments
 (0)