Skip to content

Commit 5c466e9

Browse files
committed
skip initial config for now
1 parent 159df11 commit 5c466e9

15 files changed

+112
-283
lines changed

docs/js-client-sdk.eppojsclient.initialized.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,5 @@
77
**Signature:**
88

99
```typescript
10-
static initialized: boolean;
10+
initialized: boolean;
1111
```

docs/js-client-sdk.eppojsclient.md

Lines changed: 46 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,40 @@ export declare class EppoJSClient extends EppoClient
1313
```
1414
**Extends:** EppoClient
1515
16+
## Constructors
17+
18+
<table><thead><tr><th>
19+
20+
Constructor
21+
22+
23+
</th><th>
24+
25+
Modifiers
26+
27+
28+
</th><th>
29+
30+
Description
31+
32+
33+
</th></tr></thead>
34+
<tbody><tr><td>
35+
36+
[(constructor)(optionsOrConfig)](./js-client-sdk.eppojsclient._constructor_.md)
37+
38+
39+
</td><td>
40+
41+
42+
</td><td>
43+
44+
Constructs a new instance of the `EppoJSClient` class
45+
46+
47+
</td></tr>
48+
</tbody></table>
49+
1650
## Properties
1751
1852
<table><thead><tr><th>
@@ -43,8 +77,6 @@ Description
4377
4478
</td><td>
4579
46-
`static`
47-
4880
4981
</td><td>
5082
@@ -261,5 +293,17 @@ Description
261293
</td><td>
262294
263295
296+
</td></tr>
297+
<tr><td>
298+
299+
[waitForReady()](./js-client-sdk.eppojsclient.waitforready.md)
300+
301+
302+
</td><td>
303+
304+
305+
</td><td>
306+
307+
264308
</td></tr>
265309
</tbody></table>

docs/js-client-sdk.getinstance.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,11 @@ Used to access a singleton SDK client instance. Use the method after calling ini
99
**Signature:**
1010

1111
```typescript
12-
export declare function getInstance(): EppoClient;
12+
export declare function getInstance(): EppoJSClient;
1313
```
1414
**Returns:**
1515

16-
EppoClient
16+
[EppoJSClient](./js-client-sdk.eppojsclient.md)
1717

1818
a singleton client instance
1919

docs/js-client-sdk.iclientconfig.eventingestionconfig.md

Lines changed: 0 additions & 20 deletions
This file was deleted.

docs/js-client-sdk.iclientconfig.forcereinitialize.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/js-client-sdk.iclientconfig.maxcacheageseconds.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/js-client-sdk.iclientconfig.md

Lines changed: 2 additions & 161 deletions
Original file line numberDiff line numberDiff line change
@@ -2,171 +2,12 @@
22

33
[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [IClientConfig](./js-client-sdk.iclientconfig.md)
44

5-
## IClientConfig interface
5+
## IClientConfig type
66

77
Configuration for regular client initialization
88

99
**Signature:**
1010

1111
```typescript
12-
export interface IClientConfig extends IBaseRequestConfig
12+
export declare type IClientConfig = Omit<IClientOptions, 'sdkKey' | 'offline'> & Pick<IBaseRequestConfig, 'apiKey'>;
1313
```
14-
**Extends:** IBaseRequestConfig
15-
16-
## Properties
17-
18-
<table><thead><tr><th>
19-
20-
Property
21-
22-
23-
</th><th>
24-
25-
Modifiers
26-
27-
28-
</th><th>
29-
30-
Type
31-
32-
33-
</th><th>
34-
35-
Description
36-
37-
38-
</th></tr></thead>
39-
<tbody><tr><td>
40-
41-
[eventIngestionConfig?](./js-client-sdk.iclientconfig.eventingestionconfig.md)
42-
43-
44-
</td><td>
45-
46-
47-
</td><td>
48-
49-
{ deliveryIntervalMs?: number; retryIntervalMs?: number; maxRetryDelayMs?: number; maxRetries?: number; batchSize?: number; maxQueueSize?: number; }
50-
51-
52-
</td><td>
53-
54-
_(Optional)_ Configuration settings for the event dispatcher
55-
56-
57-
</td></tr>
58-
<tr><td>
59-
60-
[forceReinitialize?](./js-client-sdk.iclientconfig.forcereinitialize.md)
61-
62-
63-
</td><td>
64-
65-
66-
</td><td>
67-
68-
boolean
69-
70-
71-
</td><td>
72-
73-
_(Optional)_ Force reinitialize the SDK if it is already initialized.
74-
75-
76-
</td></tr>
77-
<tr><td>
78-
79-
[maxCacheAgeSeconds?](./js-client-sdk.iclientconfig.maxcacheageseconds.md)
80-
81-
82-
</td><td>
83-
84-
85-
</td><td>
86-
87-
number
88-
89-
90-
</td><td>
91-
92-
_(Optional)_ Maximum age, in seconds, previously cached values are considered valid until new values will be fetched (default: 0)
93-
94-
95-
</td></tr>
96-
<tr><td>
97-
98-
[persistentStore?](./js-client-sdk.iclientconfig.persistentstore.md)
99-
100-
101-
</td><td>
102-
103-
104-
</td><td>
105-
106-
IAsyncStore&lt;Flag&gt;
107-
108-
109-
</td><td>
110-
111-
_(Optional)_ A custom class to use for storing flag configurations. This is useful for cases where you want to use a different storage mechanism than the default storage provided by the SDK.
112-
113-
114-
</td></tr>
115-
<tr><td>
116-
117-
[throwOnFailedInitialization?](./js-client-sdk.iclientconfig.throwonfailedinitialization.md)
118-
119-
120-
</td><td>
121-
122-
123-
</td><td>
124-
125-
boolean
126-
127-
128-
</td><td>
129-
130-
_(Optional)_ Throw an error if unable to fetch an initial configuration during initialization. (default: true)
131-
132-
133-
</td></tr>
134-
<tr><td>
135-
136-
[updateOnFetch?](./js-client-sdk.iclientconfig.updateonfetch.md)
137-
138-
139-
</td><td>
140-
141-
142-
</td><td>
143-
144-
ServingStoreUpdateStrategy
145-
146-
147-
</td><td>
148-
149-
_(Optional)_ Sets how the configuration is updated after a successful fetch - always: immediately start using the new configuration - expired: immediately start using the new configuration only if the current one has expired - empty: only use the new configuration if the current one is both expired and uninitialized/empty
150-
151-
152-
</td></tr>
153-
<tr><td>
154-
155-
[useExpiredCache?](./js-client-sdk.iclientconfig.useexpiredcache.md)
156-
157-
158-
</td><td>
159-
160-
161-
</td><td>
162-
163-
boolean
164-
165-
166-
</td><td>
167-
168-
_(Optional)_ Whether initialization will be considered successfully complete if expired cache values are loaded. If false, initialization will always wait for a fetch if cached values are expired. (default: false)
169-
170-
171-
</td></tr>
172-
</tbody></table>

docs/js-client-sdk.iclientconfig.persistentstore.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/js-client-sdk.iclientconfig.throwonfailedinitialization.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

docs/js-client-sdk.iclientconfig.updateonfetch.md

Lines changed: 0 additions & 13 deletions
This file was deleted.

0 commit comments

Comments
 (0)