Skip to content

Commit d5c9a91

Browse files
sameeranksameerank
authored
chore: upgrade to [email protected] (#112)
* yarn add @eppo/[email protected] * yarn version patch * fix: use [email protected] to upgrade yarn.lock file * fix: selective resolution for minimatch to stay compatible with node 18 * fix: regenerate lockfile with node 18
1 parent e2af172 commit d5c9a91

8 files changed

+2528
-1808
lines changed

‎docs/index.md‎

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,25 @@
66

77
## Packages
88

9-
| Package | Description |
10-
| --- | --- |
11-
| [@eppo/node-server-sdk](./node-server-sdk.md) | |
9+
<table><thead><tr><th>
10+
11+
Package
12+
13+
14+
</th><th>
15+
16+
Description
17+
18+
19+
</th></tr></thead>
20+
<tbody><tr><td>
21+
22+
[@eppo/node-server-sdk](./node-server-sdk.md)
23+
24+
25+
</td><td>
26+
27+
28+
</td></tr>
29+
</tbody></table>
1230

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

Lines changed: 250 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -14,17 +14,254 @@ export interface IClientConfig
1414

1515
## Properties
1616

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-
| [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 |
24-
| [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) |
25-
| [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) |
26-
| [pollAfterFailedInitialization?](./node-server-sdk.iclientconfig.pollafterfailedinitialization.md) | | boolean | _(Optional)_ Poll for new configurations even if the initial configuration request failed. (default: false) |
27-
| [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). |
28-
| [requestTimeoutMs?](./node-server-sdk.iclientconfig.requesttimeoutms.md) | | number | _(Optional)_ Timeout in milliseconds for the HTTPS request for the experiment configuration. (Default: 5000) |
29-
| [throwOnFailedInitialization?](./node-server-sdk.iclientconfig.throwonfailedinitialization.md) | | boolean | _(Optional)_ Throw error if unable to fetch an initial configuration during initialization. (default: true) |
17+
<table><thead><tr><th>
18+
19+
Property
20+
21+
22+
</th><th>
23+
24+
Modifiers
25+
26+
27+
</th><th>
28+
29+
Type
30+
31+
32+
</th><th>
33+
34+
Description
35+
36+
37+
</th></tr></thead>
38+
<tbody><tr><td>
39+
40+
[apiKey](./node-server-sdk.iclientconfig.apikey.md)
41+
42+
43+
</td><td>
44+
45+
46+
</td><td>
47+
48+
string
49+
50+
51+
</td><td>
52+
53+
Eppo SDK key
54+
55+
56+
</td></tr>
57+
<tr><td>
58+
59+
[assignmentLogger](./node-server-sdk.iclientconfig.assignmentlogger.md)
60+
61+
62+
</td><td>
63+
64+
65+
</td><td>
66+
67+
IAssignmentLogger
68+
69+
70+
</td><td>
71+
72+
Provide a logging implementation to send variation assignments to your data warehouse.
73+
74+
75+
</td></tr>
76+
<tr><td>
77+
78+
[banditLogger?](./node-server-sdk.iclientconfig.banditlogger.md)
79+
80+
81+
</td><td>
82+
83+
84+
</td><td>
85+
86+
IBanditLogger
87+
88+
89+
</td><td>
90+
91+
_(Optional)_ Logging implementation to send bandit actions to your data warehouse
92+
93+
94+
</td></tr>
95+
<tr><td>
96+
97+
[baseUrl?](./node-server-sdk.iclientconfig.baseurl.md)
98+
99+
100+
</td><td>
101+
102+
103+
</td><td>
104+
105+
string
106+
107+
108+
</td><td>
109+
110+
_(Optional)_ Base URL of the Eppo API. Clients should use the default setting in most cases.
111+
112+
113+
</td></tr>
114+
<tr><td>
115+
116+
[eventTracking?](./node-server-sdk.iclientconfig.eventtracking.md)
117+
118+
119+
</td><td>
120+
121+
122+
</td><td>
123+
124+
{ batchSize?: number; deliveryIntervalMs?: number; enabled?: boolean; maxQueueSize?: number; maxRetries?: number; maxRetryDelayMs?: number; retryIntervalMs?: number; }
125+
126+
127+
</td><td>
128+
129+
_(Optional)_ Configuration settings for the event dispatcher
130+
131+
132+
</td></tr>
133+
<tr><td>
134+
135+
[numInitialRequestRetries?](./node-server-sdk.iclientconfig.numinitialrequestretries.md)
136+
137+
138+
</td><td>
139+
140+
141+
</td><td>
142+
143+
number
144+
145+
146+
</td><td>
147+
148+
_(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)
149+
150+
151+
</td></tr>
152+
<tr><td>
153+
154+
[numPollRequestRetries?](./node-server-sdk.iclientconfig.numpollrequestretries.md)
155+
156+
157+
</td><td>
158+
159+
160+
</td><td>
161+
162+
number
163+
164+
165+
</td><td>
166+
167+
_(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)
168+
169+
170+
</td></tr>
171+
<tr><td>
172+
173+
[pollAfterFailedInitialization?](./node-server-sdk.iclientconfig.pollafterfailedinitialization.md)
174+
175+
176+
</td><td>
177+
178+
179+
</td><td>
180+
181+
boolean
182+
183+
184+
</td><td>
185+
186+
_(Optional)_ Poll for new configurations even if the initial configuration request failed. (default: false)
187+
188+
189+
</td></tr>
190+
<tr><td>
191+
192+
[pollAfterSuccessfulInitialization?](./node-server-sdk.iclientconfig.pollaftersuccessfulinitialization.md)
193+
194+
195+
</td><td>
196+
197+
198+
</td><td>
199+
200+
boolean
201+
202+
203+
</td><td>
204+
205+
_(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.
206+
207+
208+
</td></tr>
209+
<tr><td>
210+
211+
[pollingIntervalMs?](./node-server-sdk.iclientconfig.pollingintervalms.md)
212+
213+
214+
</td><td>
215+
216+
217+
</td><td>
218+
219+
number
220+
221+
222+
</td><td>
223+
224+
_(Optional)_ Amount of time in milliseconds to wait between API calls to refresh configuration data. Default of 30\_000 (30s).
225+
226+
227+
</td></tr>
228+
<tr><td>
229+
230+
[requestTimeoutMs?](./node-server-sdk.iclientconfig.requesttimeoutms.md)
231+
232+
233+
</td><td>
234+
235+
236+
</td><td>
237+
238+
number
239+
240+
241+
</td><td>
242+
243+
_(Optional)_ Timeout in milliseconds for the HTTPS request for the experiment configuration. (Default: 5000)
244+
245+
246+
</td></tr>
247+
<tr><td>
248+
249+
[throwOnFailedInitialization?](./node-server-sdk.iclientconfig.throwonfailedinitialization.md)
250+
251+
252+
</td><td>
253+
254+
255+
</td><td>
256+
257+
boolean
258+
259+
260+
</td><td>
261+
262+
_(Optional)_ Throw error if unable to fetch an initial configuration during initialization. (default: true)
263+
264+
265+
</td></tr>
266+
</tbody></table>
30267

‎docs/node-server-sdk.iclientconfig.pollaftersuccessfulinitialization.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; [pollAfterSuccessfulInitialization](./node-server-sdk.iclientconfig.pollaftersuccessfulinitialization.md)
4+
5+
## IClientConfig.pollAfterSuccessfulInitialization property
6+
7+
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.
8+
9+
**Signature:**
10+
11+
```typescript
12+
pollAfterSuccessfulInitialization?: boolean;
13+
```

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

Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -14,9 +14,39 @@ export declare function init(config: IClientConfig): Promise<EppoClient>;
1414

1515
## Parameters
1616

17-
| Parameter | Type | Description |
18-
| --- | --- | --- |
19-
| config | [IClientConfig](./node-server-sdk.iclientconfig.md) | client configuration |
17+
<table><thead><tr><th>
18+
19+
Parameter
20+
21+
22+
</th><th>
23+
24+
Type
25+
26+
27+
</th><th>
28+
29+
Description
30+
31+
32+
</th></tr></thead>
33+
<tbody><tr><td>
34+
35+
config
36+
37+
38+
</td><td>
39+
40+
[IClientConfig](./node-server-sdk.iclientconfig.md)
41+
42+
43+
</td><td>
44+
45+
client configuration
46+
47+
48+
</td></tr>
49+
</tbody></table>
2050

2151
**Returns:**
2252

0 commit comments

Comments
 (0)