Skip to content
Merged
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
24 changes: 21 additions & 3 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,25 @@

## Packages

| Package | Description |
| --- | --- |
| [@eppo/node-server-sdk](./node-server-sdk.md) | |
<table><thead><tr><th>
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Big regeneration of docs guessing the auto doc package updated?

Copy link
Contributor Author

@sameerank sameerank Aug 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You can see that it jumped a few patch versions

node-server-sdk/yarn.lock

Lines 628 to 667 in b96a888

"@microsoft/api-documenter@^7.23.9":
version "7.26.31"
resolved "https://registry.yarnpkg.com/@microsoft/api-documenter/-/api-documenter-7.26.31.tgz#7307fee2f4ebd348c45df4de32a2182031528a44"
integrity sha512-eGp0nf/wTnuFTNf2WI998i0sjZNbFY2AiIC3BAy8BJOu3jYCYB8+zd/uE004eF4JE6bLNXAUqBXYcu5BD2aWCA==
dependencies:
"@microsoft/api-extractor-model" "7.30.7"
"@microsoft/tsdoc" "~0.15.1"
"@rushstack/node-core-library" "5.14.0"
"@rushstack/terminal" "0.15.4"
"@rushstack/ts-command-line" "5.0.2"
js-yaml "~3.13.1"
resolve "~1.22.1"
"@microsoft/[email protected]":
version "7.30.7"
resolved "https://registry.yarnpkg.com/@microsoft/api-extractor-model/-/api-extractor-model-7.30.7.tgz#a87cd3332cd1016e47a6f4a1c4585024aa92bc7d"
integrity sha512-TBbmSI2/BHpfR9YhQA7nH0nqVmGgJ0xH0Ex4D99/qBDAUpnhA2oikGmdXanbw9AWWY/ExBYIpkmY8dBHdla3YQ==
dependencies:
"@microsoft/tsdoc" "~0.15.1"
"@microsoft/tsdoc-config" "~0.17.1"
"@rushstack/node-core-library" "5.14.0"
"@microsoft/api-extractor@^7.38.0":
version "7.52.10"
resolved "https://registry.yarnpkg.com/@microsoft/api-extractor/-/api-extractor-7.52.10.tgz#bbae187c209b537a39f08592577fa1dd50b22e15"
integrity sha512-LhKytJM5ZJkbHQVfW/3o747rZUNs/MGg6j/wt/9qwwqEOfvUDTYXXxIBuMgrRXhJ528p41iyz4zjBVHZU74Odg==
dependencies:
"@microsoft/api-extractor-model" "7.30.7"
"@microsoft/tsdoc" "~0.15.1"
"@microsoft/tsdoc-config" "~0.17.1"
"@rushstack/node-core-library" "5.14.0"
"@rushstack/rig-package" "0.5.3"
"@rushstack/terminal" "0.15.4"
"@rushstack/ts-command-line" "5.0.2"
lodash "~4.17.15"
minimatch "10.0.3"
resolve "~1.22.1"
semver "~7.5.4"
source-map "~0.6.1"
typescript "5.8.2"

And the dependencies (like typescript and minimatch) eventually trace their way back to the dependabot bumped versions in the latest common release https://github.com/Eppo-exp/js-sdk-common/releases/tag/v4.15.2


Package


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[@eppo/node-server-sdk](./node-server-sdk.md)


</td><td>


</td></tr>
</tbody></table>

263 changes: 250 additions & 13 deletions docs/node-server-sdk.iclientconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,17 +14,254 @@ export interface IClientConfig

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [apiKey](./node-server-sdk.iclientconfig.apikey.md) | | string | Eppo SDK key |
| [assignmentLogger](./node-server-sdk.iclientconfig.assignmentlogger.md) | | IAssignmentLogger | Provide a logging implementation to send variation assignments to your data warehouse. |
| [banditLogger?](./node-server-sdk.iclientconfig.banditlogger.md) | | IBanditLogger | _(Optional)_ Logging implementation to send bandit actions to your data warehouse |
| [baseUrl?](./node-server-sdk.iclientconfig.baseurl.md) | | string | _(Optional)_ Base URL of the Eppo API. Clients should use the default setting in most cases. |
| [eventTracking?](./node-server-sdk.iclientconfig.eventtracking.md) | | { batchSize?: number; deliveryIntervalMs?: number; enabled?: boolean; maxQueueSize?: number; maxRetries?: number; maxRetryDelayMs?: number; retryIntervalMs?: number; } | _(Optional)_ Configuration settings for the event dispatcher |
| [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) |
| [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) |
| [pollAfterFailedInitialization?](./node-server-sdk.iclientconfig.pollafterfailedinitialization.md) | | boolean | _(Optional)_ Poll for new configurations even if the initial configuration request failed. (default: false) |
| [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). |
| [requestTimeoutMs?](./node-server-sdk.iclientconfig.requesttimeoutms.md) | | number | _(Optional)_ Timeout in milliseconds for the HTTPS request for the experiment configuration. (Default: 5000) |
| [throwOnFailedInitialization?](./node-server-sdk.iclientconfig.throwonfailedinitialization.md) | | boolean | _(Optional)_ Throw error if unable to fetch an initial configuration during initialization. (default: true) |
<table><thead><tr><th>

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

[apiKey](./node-server-sdk.iclientconfig.apikey.md)


</td><td>


</td><td>

string


</td><td>

Eppo SDK key


</td></tr>
<tr><td>

[assignmentLogger](./node-server-sdk.iclientconfig.assignmentlogger.md)


</td><td>


</td><td>

IAssignmentLogger


</td><td>

Provide a logging implementation to send variation assignments to your data warehouse.


</td></tr>
<tr><td>

[banditLogger?](./node-server-sdk.iclientconfig.banditlogger.md)


</td><td>


</td><td>

IBanditLogger


</td><td>

_(Optional)_ Logging implementation to send bandit actions to your data warehouse


</td></tr>
<tr><td>

[baseUrl?](./node-server-sdk.iclientconfig.baseurl.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ Base URL of the Eppo API. Clients should use the default setting in most cases.


</td></tr>
<tr><td>

[eventTracking?](./node-server-sdk.iclientconfig.eventtracking.md)


</td><td>


</td><td>

{ batchSize?: number; deliveryIntervalMs?: number; enabled?: boolean; maxQueueSize?: number; maxRetries?: number; maxRetryDelayMs?: number; retryIntervalMs?: number; }


</td><td>

_(Optional)_ Configuration settings for the event dispatcher


</td></tr>
<tr><td>

[numInitialRequestRetries?](./node-server-sdk.iclientconfig.numinitialrequestretries.md)


</td><td>


</td><td>

number


</td><td>

_(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)


</td></tr>
<tr><td>

[numPollRequestRetries?](./node-server-sdk.iclientconfig.numpollrequestretries.md)


</td><td>


</td><td>

number


</td><td>

_(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)


</td></tr>
<tr><td>

[pollAfterFailedInitialization?](./node-server-sdk.iclientconfig.pollafterfailedinitialization.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Poll for new configurations even if the initial configuration request failed. (default: false)


</td></tr>
<tr><td>

[pollAfterSuccessfulInitialization?](./node-server-sdk.iclientconfig.pollaftersuccessfulinitialization.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Poll for new configurations (every `pollingIntervalMs`<!-- -->) after successfully requesting the initial configuration. (default: true) For server-side applications, this defaults to true to ensure configurations stay up-to-date for the life of the process.


</td></tr>
<tr><td>

[pollingIntervalMs?](./node-server-sdk.iclientconfig.pollingintervalms.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ Amount of time in milliseconds to wait between API calls to refresh configuration data. Default of 30\_000 (30s).


</td></tr>
<tr><td>

[requestTimeoutMs?](./node-server-sdk.iclientconfig.requesttimeoutms.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ Timeout in milliseconds for the HTTPS request for the experiment configuration. (Default: 5000)


</td></tr>
<tr><td>

[throwOnFailedInitialization?](./node-server-sdk.iclientconfig.throwonfailedinitialization.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Throw error if unable to fetch an initial configuration during initialization. (default: true)


</td></tr>
</tbody></table>

Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@eppo/node-server-sdk](./node-server-sdk.md) &gt; [IClientConfig](./node-server-sdk.iclientconfig.md) &gt; [pollAfterSuccessfulInitialization](./node-server-sdk.iclientconfig.pollaftersuccessfulinitialization.md)

## IClientConfig.pollAfterSuccessfulInitialization property

Poll for new configurations (every `pollingIntervalMs`<!-- -->) after successfully requesting the initial configuration. (default: true) For server-side applications, this defaults to true to ensure configurations stay up-to-date for the life of the process.

**Signature:**

```typescript
pollAfterSuccessfulInitialization?: boolean;
```
36 changes: 33 additions & 3 deletions docs/node-server-sdk.init.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,9 +14,39 @@ export declare function init(config: IClientConfig): Promise<EppoClient>;

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| config | [IClientConfig](./node-server-sdk.iclientconfig.md) | client configuration |
<table><thead><tr><th>

Parameter


</th><th>

Type


</th><th>

Description


</th></tr></thead>
<tbody><tr><td>

config


</td><td>

[IClientConfig](./node-server-sdk.iclientconfig.md)


</td><td>

client configuration


</td></tr>
</tbody></table>

**Returns:**

Expand Down
Loading
Loading