Skip to content

Commit 6b1a103

Browse files
felipecslfelipecsl
authored
chore: Update docs (#114)
1 parent ac7a336 commit 6b1a103

File tree

33 files changed

+2449
-205
lines changed

33 files changed

+2449
-205
lines changed

‎docs/index.md‎

Lines changed: 20 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,24 @@
66

77
## Packages
88

9-
| Package | Description |
10-
| --- | --- |
11-
| [@eppo/js-client-sdk](./js-client-sdk.md) | |
9+
<table><thead><tr><th>
1210

11+
Package
12+
13+
14+
</th><th>
15+
16+
Description
17+
18+
19+
</th></tr></thead>
20+
<tbody><tr><td>
21+
22+
[@eppo/js-client-sdk](./js-client-sdk.md)
23+
24+
25+
</td><td>
26+
27+
28+
</td></tr>
29+
</tbody></table>

‎docs/js-client-sdk.buildstoragekeysuffix.md‎

Lines changed: 30 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -12,10 +12,37 @@ export declare function buildStorageKeySuffix(apiKey: string): string;
1212

1313
## Parameters
1414

15-
| Parameter | Type | Description |
16-
| --- | --- | --- |
17-
| apiKey | string | |
15+
<table><thead><tr><th>
1816

17+
Parameter
18+
19+
20+
</th><th>
21+
22+
Type
23+
24+
25+
</th><th>
26+
27+
Description
28+
29+
30+
</th></tr></thead>
31+
<tbody><tr><td>
32+
33+
apiKey
34+
35+
36+
</td><td>
37+
38+
string
39+
40+
41+
</td><td>
42+
43+
44+
</td></tr>
45+
</tbody></table>
1946
**Returns:**
2047

2148
string

‎docs/js-client-sdk.chromestorageengine._constructor_.md‎

Lines changed: 44 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,8 +14,48 @@ constructor(storageMap: ChromeStorageAsyncMap<string>, storageKeySuffix: string)
1414

1515
## Parameters
1616

17-
| Parameter | Type | Description |
18-
| --- | --- | --- |
19-
| storageMap | ChromeStorageAsyncMap&lt;string&gt; | |
20-
| storageKeySuffix | string | |
17+
<table><thead><tr><th>
2118

19+
Parameter
20+
21+
22+
</th><th>
23+
24+
Type
25+
26+
27+
</th><th>
28+
29+
Description
30+
31+
32+
</th></tr></thead>
33+
<tbody><tr><td>
34+
35+
storageMap
36+
37+
38+
</td><td>
39+
40+
ChromeStorageAsyncMap&lt;string&gt;
41+
42+
43+
</td><td>
44+
45+
46+
</td></tr>
47+
<tr><td>
48+
49+
storageKeySuffix
50+
51+
52+
</td><td>
53+
54+
string
55+
56+
57+
</td><td>
58+
59+
60+
</td></tr>
61+
</tbody></table>

‎docs/js-client-sdk.chromestorageengine.md‎

Lines changed: 120 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -19,16 +19,127 @@ export declare class ChromeStorageEngine implements IStringStorageEngine
1919
2020
## Constructors
2121
22-
| Constructor | Modifiers | Description |
23-
| --- | --- | --- |
24-
| [(constructor)(storageMap, storageKeySuffix)](./js-client-sdk.chromestorageengine._constructor_.md) | | Constructs a new instance of the <code>ChromeStorageEngine</code> class |
22+
<table><thead><tr><th>
23+
24+
Constructor
25+
26+
27+
</th><th>
28+
29+
Modifiers
30+
31+
32+
</th><th>
33+
34+
Description
35+
36+
37+
</th></tr></thead>
38+
<tbody><tr><td>
39+
40+
[(constructor)(storageMap, storageKeySuffix)](./js-client-sdk.chromestorageengine._constructor_.md)
41+
42+
43+
</td><td>
44+
45+
46+
</td><td>
47+
48+
Constructs a new instance of the `ChromeStorageEngine` class
49+
50+
51+
</td></tr>
52+
</tbody></table>
2553
2654
## Properties
2755
28-
| Property | Modifiers | Type | Description |
29-
| --- | --- | --- | --- |
30-
| [getContentsJsonString](./js-client-sdk.chromestorageengine.getcontentsjsonstring.md) | | () =&gt; Promise&lt;string \| null&gt; | |
31-
| [getMetaJsonString](./js-client-sdk.chromestorageengine.getmetajsonstring.md) | | () =&gt; Promise&lt;string \| null&gt; | |
32-
| [setContentsJsonString](./js-client-sdk.chromestorageengine.setcontentsjsonstring.md) | | (configurationJsonString: string) =&gt; Promise&lt;void&gt; | |
33-
| [setMetaJsonString](./js-client-sdk.chromestorageengine.setmetajsonstring.md) | | (metaJsonString: string) =&gt; Promise&lt;void&gt; | |
56+
<table><thead><tr><th>
57+
58+
Property
59+
60+
61+
</th><th>
62+
63+
Modifiers
64+
65+
66+
</th><th>
67+
68+
Type
69+
70+
71+
</th><th>
72+
73+
Description
74+
75+
76+
</th></tr></thead>
77+
<tbody><tr><td>
78+
79+
[getContentsJsonString](./js-client-sdk.chromestorageengine.getcontentsjsonstring.md)
80+
81+
82+
</td><td>
83+
84+
85+
</td><td>
86+
87+
() =&gt; Promise&lt;string \| null&gt;
88+
89+
90+
</td><td>
91+
92+
93+
</td></tr>
94+
<tr><td>
95+
96+
[getMetaJsonString](./js-client-sdk.chromestorageengine.getmetajsonstring.md)
97+
98+
99+
</td><td>
100+
101+
102+
</td><td>
103+
104+
() =&gt; Promise&lt;string \| null&gt;
105+
106+
107+
</td><td>
108+
109+
110+
</td></tr>
111+
<tr><td>
112+
113+
[setContentsJsonString](./js-client-sdk.chromestorageengine.setcontentsjsonstring.md)
114+
115+
116+
</td><td>
117+
118+
119+
</td><td>
120+
121+
(configurationJsonString: string) =&gt; Promise&lt;void&gt;
122+
123+
124+
</td><td>
125+
126+
127+
</td></tr>
128+
<tr><td>
129+
130+
[setMetaJsonString](./js-client-sdk.chromestorageengine.setmetajsonstring.md)
131+
132+
133+
</td><td>
134+
135+
136+
</td><td>
137+
138+
(metaJsonString: string) =&gt; Promise&lt;void&gt;
139+
140+
141+
</td><td>
142+
34143
144+
</td></tr>
145+
</tbody></table>

‎docs/js-client-sdk.eppojsclient.getbanditaction.md‎

Lines changed: 86 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -12,14 +12,93 @@ getBanditAction(flagKey: string, subjectKey: string, subjectAttributes: BanditSu
1212

1313
## Parameters
1414

15-
| Parameter | Type | Description |
16-
| --- | --- | --- |
17-
| flagKey | string | |
18-
| subjectKey | string | |
19-
| subjectAttributes | BanditSubjectAttributes | |
20-
| actions | BanditActions | |
21-
| defaultValue | string | |
15+
<table><thead><tr><th>
2216

17+
Parameter
18+
19+
20+
</th><th>
21+
22+
Type
23+
24+
25+
</th><th>
26+
27+
Description
28+
29+
30+
</th></tr></thead>
31+
<tbody><tr><td>
32+
33+
flagKey
34+
35+
36+
</td><td>
37+
38+
string
39+
40+
41+
</td><td>
42+
43+
44+
</td></tr>
45+
<tr><td>
46+
47+
subjectKey
48+
49+
50+
</td><td>
51+
52+
string
53+
54+
55+
</td><td>
56+
57+
58+
</td></tr>
59+
<tr><td>
60+
61+
subjectAttributes
62+
63+
64+
</td><td>
65+
66+
BanditSubjectAttributes
67+
68+
69+
</td><td>
70+
71+
72+
</td></tr>
73+
<tr><td>
74+
75+
actions
76+
77+
78+
</td><td>
79+
80+
BanditActions
81+
82+
83+
</td><td>
84+
85+
86+
</td></tr>
87+
<tr><td>
88+
89+
defaultValue
90+
91+
92+
</td><td>
93+
94+
string
95+
96+
97+
</td><td>
98+
99+
100+
</td></tr>
101+
</tbody></table>
23102
**Returns:**
24103

25104
Omit&lt;IAssignmentDetails&lt;string&gt;, 'evaluationDetails'&gt;

0 commit comments

Comments
 (0)