Skip to content
Open
Show file tree
Hide file tree
Changes from 12 commits
Commits
Show all changes
48 commits
Select commit Hold shift + click to select a range
e20ef73
detatched construction
typotter Jan 30, 2025
50e66aa
combine new and old constructors
typotter Jan 30, 2025
de9f653
use spark for md5 instead of non-exported member from common
typotter Jan 31, 2025
fa5baab
update to latest common, use exported members
typotter Jan 31, 2025
953c4e4
doc comments
typotter Jan 31, 2025
159df11
wip
typotter Jan 31, 2025
a73bf0c
skip initial config for now
typotter Jan 31, 2025
7e5abe1
exports
typotter Jan 31, 2025
92cdd1d
waitForReady
typotter Jan 31, 2025
c4b2717
clean up offline init method
typotter Jan 31, 2025
ddab6c0
no need to export
typotter Jan 31, 2025
d55d23d
DOCS
typotter Jan 31, 2025
3c18bc9
builder method
typotter Feb 4, 2025
4b8077f
polish
typotter Feb 5, 2025
621cccb
chore: Move initialization code from static to the instance
typotter Feb 11, 2025
ed3c4ce
docs
typotter Feb 11, 2025
5f96888
lint
typotter Feb 12, 2025
228e1e4
move reinit check
typotter Feb 13, 2025
4d35d4f
restore buffered init
typotter Feb 13, 2025
cf3c2ba
docs
typotter Feb 13, 2025
132c0a5
docs
typotter Feb 13, 2025
6141581
polish
typotter Feb 5, 2025
82ec342
test name
typotter Feb 5, 2025
81ff3b1
move comment
typotter Feb 11, 2025
fad43d3
move forceReinit
typotter Feb 13, 2025
febb3f8
docs
typotter Feb 13, 2025
212e26e
move members
typotter Feb 13, 2025
a943e90
refactor wip
typotter Feb 14, 2025
ba219f2
chore: Move initialization code from static to the instance
typotter Feb 11, 2025
5333574
docs
typotter Feb 11, 2025
aab1009
lint
typotter Feb 12, 2025
f93fa61
docs
typotter Feb 13, 2025
030aa33
docs
typotter Feb 14, 2025
e61ec6c
merge fixes
typotter Feb 14, 2025
a000205
fix the horrible diff and merge artifacts
typotter Feb 14, 2025
6f1a68e
docs
typotter Feb 14, 2025
654ffaa
cleamup merge
typotter Feb 14, 2025
74498b9
merge main
typotter Feb 18, 2025
9176d21
docs
typotter Feb 18, 2025
a179e32
merge main
typotter Feb 21, 2025
0734752
chore: lint
typotter Feb 21, 2025
fb76db9
undeprecate
typotter Feb 21, 2025
a384132
chore: additional comments
typotter Feb 21, 2025
3ae0ec7
chore: update docs
typotter Feb 21, 2025
98bd24a
chore: deprecate static EppoJSClient.initialized
typotter Feb 21, 2025
2d45fe5
v3.12.0
typotter Feb 21, 2025
5d3cabc
Merge branch 'main' into tp/namespace
typotter Feb 24, 2025
2712f6b
chore: nit
typotter Feb 24, 2025
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
47 changes: 47 additions & 0 deletions docs/js-client-sdk.eppojsclient._constructor_.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [EppoJSClient](./js-client-sdk.eppojsclient.md) &gt; [(constructor)](./js-client-sdk.eppojsclient._constructor_.md)

## EppoJSClient.(constructor)

Constructs a new instance of the `EppoJSClient` class

**Signature:**

```typescript
constructor(optionsOrConfig: EppoClientParameters | IClientOptions);
```

## Parameters

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

Parameter


</th><th>

Type


</th><th>

Description


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

optionsOrConfig


</td><td>

EppoClientParameters \| IClientOptions


</td><td>


</td></tr>
</tbody></table>
2 changes: 1 addition & 1 deletion docs/js-client-sdk.eppojsclient.initialized.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,5 +7,5 @@
**Signature:**

```typescript
static initialized: boolean;
initialized: boolean;
```
48 changes: 46 additions & 2 deletions docs/js-client-sdk.eppojsclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,40 @@ export declare class EppoJSClient extends EppoClient
```
**Extends:** EppoClient

## Constructors

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

Constructor


</th><th>

Modifiers


</th><th>

Description


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

[(constructor)(optionsOrConfig)](./js-client-sdk.eppojsclient._constructor_.md)


</td><td>


</td><td>

Constructs a new instance of the `EppoJSClient` class


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

## Properties

<table><thead><tr><th>
Expand Down Expand Up @@ -43,8 +77,6 @@ Description

</td><td>

`static`


</td><td>

Expand Down Expand Up @@ -261,5 +293,17 @@ Description
</td><td>


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

[waitForReady()](./js-client-sdk.eppojsclient.waitforready.md)


</td><td>


</td><td>


</td></tr>
</tbody></table>
15 changes: 15 additions & 0 deletions docs/js-client-sdk.eppojsclient.waitforready.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
<!-- Do not edit this file. It is automatically generated by API Documenter. -->

[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [EppoJSClient](./js-client-sdk.eppojsclient.md) &gt; [waitForReady](./js-client-sdk.eppojsclient.waitforready.md)

## EppoJSClient.waitForReady() method

**Signature:**

```typescript
waitForReady(): Promise<void>;
```
**Returns:**

Promise&lt;void&gt;

4 changes: 2 additions & 2 deletions docs/js-client-sdk.getinstance.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,11 @@ Used to access a singleton SDK client instance. Use the method after calling ini
**Signature:**

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

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

a singleton client instance

20 changes: 0 additions & 20 deletions docs/js-client-sdk.iclientconfig.eventingestionconfig.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/js-client-sdk.iclientconfig.forcereinitialize.md

This file was deleted.

13 changes: 0 additions & 13 deletions docs/js-client-sdk.iclientconfig.maxcacheageseconds.md

This file was deleted.

163 changes: 2 additions & 161 deletions docs/js-client-sdk.iclientconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,171 +2,12 @@

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

## IClientConfig interface
## IClientConfig type

Configuration for regular client initialization

**Signature:**

```typescript
export interface IClientConfig extends IBaseRequestConfig
export declare type IClientConfig = Omit<IClientOptions, 'sdkKey' | 'offline'> & Pick<IBaseRequestConfig, 'apiKey'>;
```
**Extends:** IBaseRequestConfig

## Properties

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

Property


</th><th>

Modifiers


</th><th>

Type


</th><th>

Description


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

[eventIngestionConfig?](./js-client-sdk.iclientconfig.eventingestionconfig.md)


</td><td>


</td><td>

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


</td><td>

_(Optional)_ Configuration settings for the event dispatcher


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

[forceReinitialize?](./js-client-sdk.iclientconfig.forcereinitialize.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Force reinitialize the SDK if it is already initialized.


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

[maxCacheAgeSeconds?](./js-client-sdk.iclientconfig.maxcacheageseconds.md)


</td><td>


</td><td>

number


</td><td>

_(Optional)_ Maximum age, in seconds, previously cached values are considered valid until new values will be fetched (default: 0)


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

[persistentStore?](./js-client-sdk.iclientconfig.persistentstore.md)


</td><td>


</td><td>

IAsyncStore&lt;Flag&gt;


</td><td>

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


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

[throwOnFailedInitialization?](./js-client-sdk.iclientconfig.throwonfailedinitialization.md)


</td><td>


</td><td>

boolean


</td><td>

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


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

[updateOnFetch?](./js-client-sdk.iclientconfig.updateonfetch.md)


</td><td>


</td><td>

ServingStoreUpdateStrategy


</td><td>

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


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

[useExpiredCache?](./js-client-sdk.iclientconfig.useexpiredcache.md)


</td><td>


</td><td>

boolean


</td><td>

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


</td></tr>
</tbody></table>
13 changes: 0 additions & 13 deletions docs/js-client-sdk.iclientconfig.persistentstore.md

This file was deleted.

Loading