Skip to content
Merged
Show file tree
Hide file tree
Changes from all 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
1 change: 1 addition & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -1 +1,2 @@
*.json linguist-language=JSON-with-Comments
docs/*.md text eol=lf
Copy link
Contributor Author

Choose a reason for hiding this comment

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

standardize line endings for autogenerated docs (and other files)

4 changes: 2 additions & 2 deletions .github/workflows/lint-test-sdk.yml
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [ '18', '20', '22', '23' ]
node-version: [ '20', '22', '24' ]
Copy link
Contributor Author

Choose a reason for hiding this comment

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

bumping to all LTS versions

steps:
- uses: actions/checkout@v3
with:
Expand Down Expand Up @@ -62,7 +62,7 @@ jobs:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [ '18', '20', '22', '23' ]
node-version: [ '20', '22', '24' ]
steps:
- uses: actions/checkout@v3
with:
Expand Down
2 changes: 1 addition & 1 deletion .github/workflows/publish.yml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ jobs:
fail-fast: false
matrix:
platform: ['linux']
node-version: [ '18', '20', '22', '23' ]
node-version: [ '20', '22', '24' ]
steps:
- uses: actions/checkout@v3

Expand Down
9 changes: 8 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,10 +8,17 @@

- Feature gates
- Kill switches
- Dynamic configuration
- Progressive rollouts
- A/B/n experiments
- Holdouts
- Mutually exclusive experiments (Layers)
- Dynamic configuration
- Switchback experiments
- Contextual Multi-armed bandits
Comment on lines +11 to +17
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Add some more bragging while in here!


## Requirements

- Node.js version 20.x or later
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Document our minimum version in README


## Installation

Expand Down
2 changes: 1 addition & 1 deletion api-extractor.json
Original file line number Diff line number Diff line change
Expand Up @@ -266,7 +266,7 @@
*
* DEFAULT VALUE: "crlf"
*/
// "newlineKind": "crlf",
"newlineKind": "lf",
Copy link
Contributor Author

Choose a reason for hiding this comment

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

same here


/**
* Configures how API Extractor reports error and warning messages produced during analysis.
Expand Down
60 changes: 30 additions & 30 deletions docs/index.md
Original file line number Diff line number Diff line change
@@ -1,30 +1,30 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
[Home](./index.md)
## API Reference
## Packages
<table><thead><tr><th>
Package
</th><th>
Description
</th></tr></thead>
<tbody><tr><td>
[@eppo/node-server-sdk](./node-server-sdk.md)
</td><td>
</td></tr>
</tbody></table>
<!-- Do not edit this file. It is automatically generated by API Documenter. -->
Copy link
Contributor Author

Choose a reason for hiding this comment

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

Docs autogenerated updated not sure why git thinks this particular change is a diff


[Home](./index.md)

## API Reference

## Packages

<table><thead><tr><th>

Package


</th><th>

Description


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

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


</td><td>


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

19 changes: 19 additions & 0 deletions docs/node-server-sdk.getbanditsconfiguration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- 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; [getBanditsConfiguration](./node-server-sdk.getbanditsconfiguration.md)

## getBanditsConfiguration() function

Returns the current bandits configuration as a JSON string. This can be used together with getFlagsConfiguration() to bootstrap another SDK instance using offlineInit().

**Signature:**

```typescript
export declare function getBanditsConfiguration(): string;
```
**Returns:**

string

JSON string containing the bandits configuration

19 changes: 19 additions & 0 deletions docs/node-server-sdk.getflagsconfiguration.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
<!-- 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; [getFlagsConfiguration](./node-server-sdk.getflagsconfiguration.md)

## getFlagsConfiguration() function

Reconstructs the current flags configuration as a JSON string. This can be used to bootstrap another SDK instance using offlineInit().

**Signature:**

```typescript
export declare function getFlagsConfiguration(): string | null;
```
**Returns:**

string \| null

JSON string containing the flags configuration, or null if not initialized

38 changes: 19 additions & 19 deletions docs/node-server-sdk.getinstance.md
Original file line number Diff line number Diff line change
@@ -1,19 +1,19 @@
<!-- 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; [getInstance](./node-server-sdk.getinstance.md)
## getInstance() function
Used to access a singleton SDK client instance. Use the method after calling init() to initialize the client.
**Signature:**
```typescript
export declare function getInstance(): EppoClient;
```
**Returns:**
EppoClient
a singleton client instance or throws an Error if init() has not been called
<!-- 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; [getInstance](./node-server-sdk.getinstance.md)

## getInstance() function

Used to access a singleton SDK client instance. Use the method after calling init() to initialize the client.

**Signature:**

```typescript
export declare function getInstance(): EppoClient;
```
**Returns:**

EppoClient

a singleton client instance or throws an Error if init() has not been called

26 changes: 13 additions & 13 deletions docs/node-server-sdk.iclientconfig.apikey.md
Original file line number Diff line number Diff line change
@@ -1,13 +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; [apiKey](./node-server-sdk.iclientconfig.apikey.md)
## IClientConfig.apiKey property
Eppo SDK key
**Signature:**
```typescript
apiKey: string;
```
<!-- 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; [apiKey](./node-server-sdk.iclientconfig.apikey.md)

## IClientConfig.apiKey property

Eppo SDK key

**Signature:**

```typescript
apiKey: string;
```
26 changes: 13 additions & 13 deletions docs/node-server-sdk.iclientconfig.assignmentlogger.md
Original file line number Diff line number Diff line change
@@ -1,13 +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; [assignmentLogger](./node-server-sdk.iclientconfig.assignmentlogger.md)
## IClientConfig.assignmentLogger property
Provide a logging implementation to send variation assignments to your data warehouse.
**Signature:**
```typescript
assignmentLogger: IAssignmentLogger;
```
<!-- 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; [assignmentLogger](./node-server-sdk.iclientconfig.assignmentlogger.md)

## IClientConfig.assignmentLogger property

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

**Signature:**

```typescript
assignmentLogger: IAssignmentLogger;
```
26 changes: 13 additions & 13 deletions docs/node-server-sdk.iclientconfig.banditlogger.md
Original file line number Diff line number Diff line change
@@ -1,13 +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; [banditLogger](./node-server-sdk.iclientconfig.banditlogger.md)
## IClientConfig.banditLogger property
Logging implementation to send bandit actions to your data warehouse
**Signature:**
```typescript
banditLogger?: IBanditLogger;
```
<!-- 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; [banditLogger](./node-server-sdk.iclientconfig.banditlogger.md)

## IClientConfig.banditLogger property

Logging implementation to send bandit actions to your data warehouse

**Signature:**

```typescript
banditLogger?: IBanditLogger;
```
26 changes: 13 additions & 13 deletions docs/node-server-sdk.iclientconfig.baseurl.md
Original file line number Diff line number Diff line change
@@ -1,13 +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; [baseUrl](./node-server-sdk.iclientconfig.baseurl.md)
## IClientConfig.baseUrl property
Base URL of the Eppo API. Clients should use the default setting in most cases.
**Signature:**
```typescript
baseUrl?: string;
```
<!-- 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; [baseUrl](./node-server-sdk.iclientconfig.baseurl.md)

## IClientConfig.baseUrl property

Base URL of the Eppo API. Clients should use the default setting in most cases.

**Signature:**

```typescript
baseUrl?: string;
```
47 changes: 26 additions & 21 deletions docs/node-server-sdk.iclientconfig.eventtracking.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,26 @@
<!-- 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; [eventTracking](./node-server-sdk.iclientconfig.eventtracking.md)

## IClientConfig.eventTracking property

Configuration settings for the event dispatcher

**Signature:**

```typescript
eventTracking?: {
batchSize?: number;
deliveryIntervalMs?: number;
enabled?: boolean;
maxQueueSize?: number;
maxRetries?: number;
maxRetryDelayMs?: number;
retryIntervalMs?: number;
};
```
<!-- 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; [eventTracking](./node-server-sdk.iclientconfig.eventtracking.md)

## IClientConfig.eventTracking property

> Warning: This API is now obsolete.
>
> Eppo has discontinued eventing support. Event tracking will be handled by Datadog SDKs.
>

Configuration settings for the event dispatcher.

**Signature:**

```typescript
eventTracking?: {
batchSize?: number;
deliveryIntervalMs?: number;
enabled?: boolean;
maxQueueSize?: number;
maxRetries?: number;
maxRetryDelayMs?: number;
retryIntervalMs?: number;
};
```
Loading