docs

Author: ploomiz

docs/js-client-sdk.dummy.md renamed to docs/js-client-sdk.attributevaluetype.md

@@ -1,17 +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; [dummy](./js-client-sdk.dummy.md)
+[Home](./index.md) &gt; [@eppo/js-client-sdk](./js-client-sdk.md) &gt; [AttributeValueType](./js-client-sdk.attributevaluetype.md)
 
-## dummy() function
-
-Test documentation
+## AttributeValueType type
 
 <b>Signature:</b>
 
 ```typescript
-export declare function dummy(): string;
+export declare type AttributeValueType = string | number;
 ```
-<b>Returns:</b>
-
-string
-

docs/js-client-sdk.getinstance.md

@@ -13,7 +13,7 @@ export declare function getInstance(): IEppoClient;
 ```
 <b>Returns:</b>
 
-IEppoClient
+[IEppoClient](./js-client-sdk.ieppoclient.md)
 
 a singleton client instance
 

docs/js-client-sdk.iclientconfig.md

@@ -18,6 +18,6 @@ export interface IClientConfig
 |  --- | --- | --- |
 |  [apiKey](./js-client-sdk.iclientconfig.apikey.md) | string | Eppo API key |
 |  [baseUrl?](./js-client-sdk.iclientconfig.baseurl.md) | string | <i>(Optional)</i> Base URL of the Eppo API. Clients should use the default setting in most cases. |
-|  [subjectAttributes?](./js-client-sdk.iclientconfig.subjectattributes.md) | Record&lt;string, AttributeValueType&gt; | <i>(Optional)</i> Optional attributes associated with the subject, for example name and email. The subject attributes are used for evaluating any targeting rules tied to the experiment. |
+|  [subjectAttributes?](./js-client-sdk.iclientconfig.subjectattributes.md) | Record&lt;string, [AttributeValueType](./js-client-sdk.attributevaluetype.md)<!-- -->&gt; | <i>(Optional)</i> Optional attributes associated with the subject, for example name and email. The subject attributes are used for evaluating any targeting rules tied to the experiment. |
 |  [subjectKey](./js-client-sdk.iclientconfig.subjectkey.md) | string | An identifier of the experiment subject, for example a user ID. |
 

docs/js-client-sdk.ieppoclient.getassignment.md

@@ -0,0 +1,26 @@
+<!-- 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; [IEppoClient](./js-client-sdk.ieppoclient.md) &gt; [getAssignment](./js-client-sdk.ieppoclient.getassignment.md)
+
+## IEppoClient.getAssignment() method
+
+Maps a subject to a variation for a given experiment.
+
+<b>Signature:</b>
+
+```typescript
+getAssignment(experimentKey: string): string;
+```
+
+## Parameters
+
+|  Parameter | Type | Description |
+|  --- | --- | --- |
+|  experimentKey | string | experiment identifier |
+
+<b>Returns:</b>
+
+string
+
+a variation value if the subject is part of the experiment sample, otherwise null
+

docs/js-client-sdk.ieppoclient.md

@@ -0,0 +1,20 @@
+<!-- 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; [IEppoClient](./js-client-sdk.ieppoclient.md)
+
+## IEppoClient interface
+
+Client for assigning experiment variations.
+
+<b>Signature:</b>
+
+```typescript
+export interface IEppoClient 
+```
+
+## Methods
+
+|  Method | Description |
+|  --- | --- |
+|  [getAssignment(experimentKey)](./js-client-sdk.ieppoclient.getassignment.md) | Maps a subject to a variation for a given experiment. |
+

docs/js-client-sdk.init.md

@@ -20,5 +20,5 @@ export declare function init(config: IClientConfig): Promise<IEppoClient>;
 
 <b>Returns:</b>
 
-Promise&lt;IEppoClient&gt;
+Promise&lt;[IEppoClient](./js-client-sdk.ieppoclient.md)<!-- -->&gt;
 

docs/js-client-sdk.md

@@ -16,4 +16,11 @@
 |  Interface | Description |
 |  --- | --- |
 |  [IClientConfig](./js-client-sdk.iclientconfig.md) | Configuration used for initializing the Eppo client |
+|  [IEppoClient](./js-client-sdk.ieppoclient.md) | Client for assigning experiment variations. |
+
+## Type Aliases
+
+|  Type Alias | Description |
+|  --- | --- |
+|  [AttributeValueType](./js-client-sdk.attributevaluetype.md) |  |
 

js-client-sdk.api.md

@@ -4,20 +4,25 @@
 
 ```ts
 
-// Warning: (ae-forgotten-export) The symbol "IEppoClient" needs to be exported by the entry point index.d.ts
-//
+// @public (undocumented)
+export type AttributeValueType = string | number;
+
 // @public
 export function getInstance(): IEppoClient;
 
 // @public
 export interface IClientConfig {
     apiKey: string;
     baseUrl?: string;
-    // Warning: (ae-forgotten-export) The symbol "AttributeValueType" needs to be exported by the entry point index.d.ts
     subjectAttributes?: Record<string, AttributeValueType>;
     subjectKey: string;
 }
 
+// @public
+export interface IEppoClient {
+    getAssignment(experimentKey: string): string;
+}
+
 // @public
 export function init(config: IClientConfig): Promise<IEppoClient>;