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: [import apiendpoints and expose url builder] (ff-2310) #85

Merged
Merged
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
22 changes: 22 additions & 0 deletions docs/js-client-sdk.buildstoragekeysuffix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,22 @@
<!-- 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; [buildStorageKeySuffix](./js-client-sdk.buildstoragekeysuffix.md)

## buildStorageKeySuffix() function

**Signature:**

```typescript
export declare function buildStorageKeySuffix(apiKey: string): string;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| apiKey | string | |

**Returns:**

string

21 changes: 0 additions & 21 deletions docs/js-client-sdk.chromestorageasyncstore._constructor_.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/js-client-sdk.chromestorageasyncstore.getentries.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/js-client-sdk.chromestorageasyncstore.isexpired.md

This file was deleted.

15 changes: 0 additions & 15 deletions docs/js-client-sdk.chromestorageasyncstore.isinitialized.md

This file was deleted.

28 changes: 0 additions & 28 deletions docs/js-client-sdk.chromestorageasyncstore.md

This file was deleted.

22 changes: 0 additions & 22 deletions docs/js-client-sdk.chromestorageasyncstore.setentries.md

This file was deleted.

21 changes: 21 additions & 0 deletions docs/js-client-sdk.chromestorageengine._constructor_.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- 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; [ChromeStorageEngine](./js-client-sdk.chromestorageengine.md) &gt; [(constructor)](./js-client-sdk.chromestorageengine._constructor_.md)

## ChromeStorageEngine.(constructor)

Constructs a new instance of the `ChromeStorageEngine` class

**Signature:**

```typescript
constructor(storageMap: ChromeStorageAsyncMap<string>, storageKeySuffix: string);
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| storageMap | ChromeStorageAsyncMap&lt;string&gt; | |
| storageKeySuffix | string | |

11 changes: 11 additions & 0 deletions docs/js-client-sdk.chromestorageengine.getcontentsjsonstring.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; [ChromeStorageEngine](./js-client-sdk.chromestorageengine.md) &gt; [getContentsJsonString](./js-client-sdk.chromestorageengine.getcontentsjsonstring.md)

## ChromeStorageEngine.getContentsJsonString property

**Signature:**

```typescript
getContentsJsonString: () => Promise<string | null>;
```
11 changes: 11 additions & 0 deletions docs/js-client-sdk.chromestorageengine.getmetajsonstring.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; [ChromeStorageEngine](./js-client-sdk.chromestorageengine.md) &gt; [getMetaJsonString](./js-client-sdk.chromestorageengine.getmetajsonstring.md)

## ChromeStorageEngine.getMetaJsonString property

**Signature:**

```typescript
getMetaJsonString: () => Promise<string | null>;
```
34 changes: 34 additions & 0 deletions docs/js-client-sdk.chromestorageengine.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
<!-- 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; [ChromeStorageEngine](./js-client-sdk.chromestorageengine.md)

## ChromeStorageEngine class

Chrome storage implementation of a string-valued store for storing a configuration and its metadata.

This serializes the entire configuration object into a string and then stores it to a single key within the object for another single top-level key. Same with metadata about the store (e.g., when it was last updated).

Note: this behaves a bit differently than local storage as the chrome storage API gets and sets subsets of key-value pairs, so we have to dereference or re-specify the key.

**Signature:**

```typescript
export declare class ChromeStorageEngine implements IStringStorageEngine
```
**Implements:** IStringStorageEngine

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(storageMap, storageKeySuffix)](./js-client-sdk.chromestorageengine._constructor_.md) | | Constructs a new instance of the <code>ChromeStorageEngine</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [getContentsJsonString](./js-client-sdk.chromestorageengine.getcontentsjsonstring.md) | | () =&gt; Promise&lt;string \| null&gt; | |
| [getMetaJsonString](./js-client-sdk.chromestorageengine.getmetajsonstring.md) | | () =&gt; Promise&lt;string \| null&gt; | |
| [setContentsJsonString](./js-client-sdk.chromestorageengine.setcontentsjsonstring.md) | | (configurationJsonString: string) =&gt; Promise&lt;void&gt; | |
| [setMetaJsonString](./js-client-sdk.chromestorageengine.setmetajsonstring.md) | | (metaJsonString: string) =&gt; Promise&lt;void&gt; | |

11 changes: 11 additions & 0 deletions docs/js-client-sdk.chromestorageengine.setcontentsjsonstring.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; [ChromeStorageEngine](./js-client-sdk.chromestorageengine.md) &gt; [setContentsJsonString](./js-client-sdk.chromestorageengine.setcontentsjsonstring.md)

## ChromeStorageEngine.setContentsJsonString property

**Signature:**

```typescript
setContentsJsonString: (configurationJsonString: string) => Promise<void>;
```
11 changes: 11 additions & 0 deletions docs/js-client-sdk.chromestorageengine.setmetajsonstring.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; [ChromeStorageEngine](./js-client-sdk.chromestorageengine.md) &gt; [setMetaJsonString](./js-client-sdk.chromestorageengine.setmetajsonstring.md)

## ChromeStorageEngine.setMetaJsonString property

**Signature:**

```typescript
setMetaJsonString: (metaJsonString: string) => Promise<void>;
```
9 changes: 7 additions & 2 deletions docs/js-client-sdk.eppojsclient.getboolassignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,15 @@

## EppoJSClient.getBoolAssignment() method

> Warning: This API is now obsolete.
>
> Use getBooleanAssignment instead
>

**Signature:**

```typescript
getBoolAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, any>, defaultValue: boolean): boolean;
getBoolAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, AttributeType>, defaultValue: boolean): boolean;
```

## Parameters
Expand All @@ -16,7 +21,7 @@ getBoolAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record
| --- | --- | --- |
| flagKey | string | |
| subjectKey | string | |
| subjectAttributes | Record&lt;string, any&gt; | |
| subjectAttributes | Record&lt;string, AttributeType&gt; | |
| defaultValue | boolean | |

**Returns:**
Expand Down
25 changes: 25 additions & 0 deletions docs/js-client-sdk.eppojsclient.getbooleanassignment.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
<!-- 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; [getBooleanAssignment](./js-client-sdk.eppojsclient.getbooleanassignment.md)

## EppoJSClient.getBooleanAssignment() method

**Signature:**

```typescript
getBooleanAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, AttributeType>, defaultValue: boolean): boolean;
```

## Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| flagKey | string | |
| subjectKey | string | |
| subjectAttributes | Record&lt;string, AttributeType&gt; | |
| defaultValue | boolean | |

**Returns:**

boolean

4 changes: 2 additions & 2 deletions docs/js-client-sdk.eppojsclient.getintegerassignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
**Signature:**

```typescript
getIntegerAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, any>, defaultValue: number): number;
getIntegerAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, AttributeType>, defaultValue: number): number;
```

## Parameters
Expand All @@ -16,7 +16,7 @@ getIntegerAssignment(flagKey: string, subjectKey: string, subjectAttributes: Rec
| --- | --- | --- |
| flagKey | string | |
| subjectKey | string | |
| subjectAttributes | Record&lt;string, any&gt; | |
| subjectAttributes | Record&lt;string, AttributeType&gt; | |
| defaultValue | number | |

**Returns:**
Expand Down
4 changes: 2 additions & 2 deletions docs/js-client-sdk.eppojsclient.getjsonassignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
**Signature:**

```typescript
getJSONAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, any>, defaultValue: object): object;
getJSONAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, AttributeType>, defaultValue: object): object;
```

## Parameters
Expand All @@ -16,7 +16,7 @@ getJSONAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record
| --- | --- | --- |
| flagKey | string | |
| subjectKey | string | |
| subjectAttributes | Record&lt;string, any&gt; | |
| subjectAttributes | Record&lt;string, AttributeType&gt; | |
| defaultValue | object | |

**Returns:**
Expand Down
4 changes: 2 additions & 2 deletions docs/js-client-sdk.eppojsclient.getnumericassignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
**Signature:**

```typescript
getNumericAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, any>, defaultValue: number): number;
getNumericAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, AttributeType>, defaultValue: number): number;
```

## Parameters
Expand All @@ -16,7 +16,7 @@ getNumericAssignment(flagKey: string, subjectKey: string, subjectAttributes: Rec
| --- | --- | --- |
| flagKey | string | |
| subjectKey | string | |
| subjectAttributes | Record&lt;string, any&gt; | |
| subjectAttributes | Record&lt;string, AttributeType&gt; | |
| defaultValue | number | |

**Returns:**
Expand Down
4 changes: 2 additions & 2 deletions docs/js-client-sdk.eppojsclient.getstringassignment.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
**Signature:**

```typescript
getStringAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, any>, defaultValue: string): string;
getStringAssignment(flagKey: string, subjectKey: string, subjectAttributes: Record<string, AttributeType>, defaultValue: string): string;
```

## Parameters
Expand All @@ -16,7 +16,7 @@ getStringAssignment(flagKey: string, subjectKey: string, subjectAttributes: Reco
| --- | --- | --- |
| flagKey | string | |
| subjectKey | string | |
| subjectAttributes | Record&lt;string, any&gt; | |
| subjectAttributes | Record&lt;string, AttributeType&gt; | |
| defaultValue | string | |

**Returns:**
Expand Down
1 change: 1 addition & 0 deletions docs/js-client-sdk.eppojsclient.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ export declare class EppoJSClient extends EppoClient
| Method | Modifiers | Description |
| --- | --- | --- |
| [getBoolAssignment(flagKey, subjectKey, subjectAttributes, defaultValue)](./js-client-sdk.eppojsclient.getboolassignment.md) | | |
| [getBooleanAssignment(flagKey, subjectKey, subjectAttributes, defaultValue)](./js-client-sdk.eppojsclient.getbooleanassignment.md) | | |
| [getIntegerAssignment(flagKey, subjectKey, subjectAttributes, defaultValue)](./js-client-sdk.eppojsclient.getintegerassignment.md) | | |
| [getJSONAssignment(flagKey, subjectKey, subjectAttributes, defaultValue)](./js-client-sdk.eppojsclient.getjsonassignment.md) | | |
| [getNumericAssignment(flagKey, subjectKey, subjectAttributes, defaultValue)](./js-client-sdk.eppojsclient.getnumericassignment.md) | | |
Expand Down
Loading
Loading