-
Notifications
You must be signed in to change notification settings - Fork 2
Update minimum Node.js version to 20.x #120
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Changes from all commits
8867447
af8f720
db164fa
812d6ba
38d3242
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1 +1,2 @@ | ||
| *.json linguist-language=JSON-with-Comments | ||
| docs/*.md text eol=lf | ||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -25,7 +25,7 @@ jobs: | |
| runs-on: ubuntu-latest | ||
| strategy: | ||
| matrix: | ||
| node-version: [ '18', '20', '22', '23' ] | ||
| node-version: [ '20', '22', '24' ] | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. bumping to all LTS versions |
||
| steps: | ||
| - uses: actions/checkout@v3 | ||
| with: | ||
|
|
@@ -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: | ||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -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
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Document our minimum version in README |
||
|
|
||
| ## Installation | ||
|
|
||
|
|
||
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -266,7 +266,7 @@ | |
| * | ||
| * DEFAULT VALUE: "crlf" | ||
| */ | ||
| // "newlineKind": "crlf", | ||
| "newlineKind": "lf", | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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. | ||
|
|
||
| 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. --> | ||
|
Contributor
Author
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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> | ||
|
|
||
| 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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [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 | ||
|
|
| 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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [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 | ||
|
|
| 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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [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 | ||
|
|
| 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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [IClientConfig](./node-server-sdk.iclientconfig.md) > [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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [IClientConfig](./node-server-sdk.iclientconfig.md) > [apiKey](./node-server-sdk.iclientconfig.apikey.md) | ||
|
|
||
| ## IClientConfig.apiKey property | ||
|
|
||
| Eppo SDK key | ||
|
|
||
| **Signature:** | ||
|
|
||
| ```typescript | ||
| apiKey: string; | ||
| ``` |
| 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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [IClientConfig](./node-server-sdk.iclientconfig.md) > [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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [IClientConfig](./node-server-sdk.iclientconfig.md) > [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; | ||
| ``` |
| 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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [IClientConfig](./node-server-sdk.iclientconfig.md) > [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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [IClientConfig](./node-server-sdk.iclientconfig.md) > [banditLogger](./node-server-sdk.iclientconfig.banditlogger.md) | ||
|
|
||
| ## IClientConfig.banditLogger property | ||
|
|
||
| Logging implementation to send bandit actions to your data warehouse | ||
|
|
||
| **Signature:** | ||
|
|
||
| ```typescript | ||
| banditLogger?: IBanditLogger; | ||
| ``` |
| 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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [IClientConfig](./node-server-sdk.iclientconfig.md) > [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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [IClientConfig](./node-server-sdk.iclientconfig.md) > [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; | ||
| ``` |
| 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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [IClientConfig](./node-server-sdk.iclientconfig.md) > [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) > [@eppo/node-server-sdk](./node-server-sdk.md) > [IClientConfig](./node-server-sdk.iclientconfig.md) > [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; | ||
| }; | ||
| ``` |
There was a problem hiding this comment.
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)