Skip to content
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

feat: implement overrides store functionality #131

Open
wants to merge 15 commits into
base: main
Choose a base branch
from
Open
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
13 changes: 13 additions & 0 deletions docs/js-client-sdk.iclientconfig.enableoverrides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- 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; [IClientConfig](./js-client-sdk.iclientconfig.md) &gt; [enableOverrides](./js-client-sdk.iclientconfig.enableoverrides.md)

## IClientConfig.enableOverrides property

Enable the Overrides Store for local flag overrides. (default: false)

**Signature:**

```typescript
enableOverrides?: boolean;
```
38 changes: 38 additions & 0 deletions docs/js-client-sdk.iclientconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,25 @@ Description
</th></tr></thead>
<tbody><tr><td>

[enableOverrides?](./js-client-sdk.iclientconfig.enableoverrides.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Enable the Overrides Store for local flag overrides. (default: false)


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

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


Expand Down Expand Up @@ -92,6 +111,25 @@ number
_(Optional)_ Maximum age, in seconds, previously cached values are considered valid until new values will be fetched (default: 0)


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

[overridesStorageKey?](./js-client-sdk.iclientconfig.overridesstoragekey.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ The key to use for the overrides store.


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

Expand Down
13 changes: 13 additions & 0 deletions docs/js-client-sdk.iclientconfig.overridesstoragekey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- 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; [IClientConfig](./js-client-sdk.iclientconfig.md) &gt; [overridesStorageKey](./js-client-sdk.iclientconfig.overridesstoragekey.md)

## IClientConfig.overridesStorageKey property

The key to use for the overrides store.

**Signature:**

```typescript
overridesStorageKey?: string;
```
11 changes: 11 additions & 0 deletions docs/js-client-sdk.iclientconfigsync.enableoverrides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- 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; [IClientConfigSync](./js-client-sdk.iclientconfigsync.md) &gt; [enableOverrides](./js-client-sdk.iclientconfigsync.enableoverrides.md)

## IClientConfigSync.enableOverrides property

**Signature:**

```typescript
enableOverrides?: boolean;
```
38 changes: 38 additions & 0 deletions docs/js-client-sdk.iclientconfigsync.md
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,25 @@ IBanditLogger
_(Optional)_


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

[enableOverrides?](./js-client-sdk.iclientconfigsync.enableoverrides.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_


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

Expand Down Expand Up @@ -108,6 +127,25 @@ boolean
_(Optional)_


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

[overridesStorageKey?](./js-client-sdk.iclientconfigsync.overridesstoragekey.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_


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

Expand Down
11 changes: 11 additions & 0 deletions docs/js-client-sdk.iclientconfigsync.overridesstoragekey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- 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; [IClientConfigSync](./js-client-sdk.iclientconfigsync.md) &gt; [overridesStorageKey](./js-client-sdk.iclientconfigsync.overridesstoragekey.md)

## IClientConfigSync.overridesStorageKey property

**Signature:**

```typescript
overridesStorageKey?: string;
```
13 changes: 13 additions & 0 deletions docs/js-client-sdk.iprecomputedclientconfig.enableoverrides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- 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; [IPrecomputedClientConfig](./js-client-sdk.iprecomputedclientconfig.md) &gt; [enableOverrides](./js-client-sdk.iprecomputedclientconfig.enableoverrides.md)

## IPrecomputedClientConfig.enableOverrides property

Enable the Overrides Store for local flag overrides. (default: false)

**Signature:**

```typescript
enableOverrides?: boolean;
```
38 changes: 38 additions & 0 deletions docs/js-client-sdk.iprecomputedclientconfig.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,44 @@ Description
</th></tr></thead>
<tbody><tr><td>

[enableOverrides?](./js-client-sdk.iprecomputedclientconfig.enableoverrides.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_ Enable the Overrides Store for local flag overrides. (default: false)


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

[overridesStorageKey?](./js-client-sdk.iprecomputedclientconfig.overridesstoragekey.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_ The key to use for the overrides store.


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

[precompute](./js-client-sdk.iprecomputedclientconfig.precompute.md)


Expand Down
13 changes: 13 additions & 0 deletions docs/js-client-sdk.iprecomputedclientconfig.overridesstoragekey.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
<!-- 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; [IPrecomputedClientConfig](./js-client-sdk.iprecomputedclientconfig.md) &gt; [overridesStorageKey](./js-client-sdk.iprecomputedclientconfig.overridesstoragekey.md)

## IPrecomputedClientConfig.overridesStorageKey property

The key to use for the overrides store.

**Signature:**

```typescript
overridesStorageKey?: string;
```
11 changes: 11 additions & 0 deletions docs/js-client-sdk.iprecomputedclientconfigsync.enableoverrides.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- 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; [IPrecomputedClientConfigSync](./js-client-sdk.iprecomputedclientconfigsync.md) &gt; [enableOverrides](./js-client-sdk.iprecomputedclientconfigsync.enableoverrides.md)

## IPrecomputedClientConfigSync.enableOverrides property

**Signature:**

```typescript
enableOverrides?: boolean;
```
38 changes: 38 additions & 0 deletions docs/js-client-sdk.iprecomputedclientconfigsync.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,44 @@ IBanditLogger
_(Optional)_


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

[enableOverrides?](./js-client-sdk.iprecomputedclientconfigsync.enableoverrides.md)


</td><td>


</td><td>

boolean


</td><td>

_(Optional)_


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

[overridesStorageKey?](./js-client-sdk.iprecomputedclientconfigsync.overridesstoragekey.md)


</td><td>


</td><td>

string


</td><td>

_(Optional)_


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

Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<!-- 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; [IPrecomputedClientConfigSync](./js-client-sdk.iprecomputedclientconfigsync.md) &gt; [overridesStorageKey](./js-client-sdk.iprecomputedclientconfigsync.overridesstoragekey.md)

## IPrecomputedClientConfigSync.overridesStorageKey property

**Signature:**

```typescript
overridesStorageKey?: string;
```
12 changes: 12 additions & 0 deletions js-client-sdk.api.md
Original file line number Diff line number Diff line change
Expand Up @@ -137,6 +137,7 @@ export { IBanditLogger }
//
// @public
export interface IClientConfig extends IBaseRequestConfig {
enableOverrides?: boolean;
eventIngestionConfig?: {
deliveryIntervalMs?: number;
retryIntervalMs?: number;
Expand All @@ -147,6 +148,7 @@ export interface IClientConfig extends IBaseRequestConfig {
};
forceReinitialize?: boolean;
maxCacheAgeSeconds?: number;
overridesStorageKey?: string;
persistentStore?: IAsyncStore<Flag>;
throwOnFailedInitialization?: boolean;
// Warning: (ae-forgotten-export) The symbol "ServingStoreUpdateStrategy" needs to be exported by the entry point index.d.ts
Expand All @@ -161,10 +163,14 @@ export interface IClientConfigSync {
// (undocumented)
banditLogger?: IBanditLogger;
// (undocumented)
enableOverrides?: boolean;
// (undocumented)
flagsConfiguration: Record<string, Flag | ObfuscatedFlag>;
// (undocumented)
isObfuscated?: boolean;
// (undocumented)
overridesStorageKey?: string;
// (undocumented)
throwOnFailedInitialization?: boolean;
}

Expand All @@ -173,6 +179,8 @@ export function init(config: IClientConfig): Promise<EppoClient>;

// @public
export interface IPrecomputedClientConfig extends IBaseRequestConfig {
enableOverrides?: boolean;
overridesStorageKey?: string;
// Warning: (ae-forgotten-export) The symbol "IPrecompute" needs to be exported by the entry point index.d.ts
//
// (undocumented)
Expand All @@ -186,6 +194,10 @@ export interface IPrecomputedClientConfigSync {
// (undocumented)
banditLogger?: IBanditLogger;
// (undocumented)
enableOverrides?: boolean;
// (undocumented)
overridesStorageKey?: string;
// (undocumented)
precomputedConfiguration: string;
// (undocumented)
throwOnFailedInitialization?: boolean;
Expand Down
Loading
Loading