Skip to content

Commit d584a9e

Browse files
authored
chore: Clean up missing release tag warnings (#116)
* chore: Clean up missing release tag warnings * Doc update due to changed in public API signature * yarn docs
1 parent 77501d8 commit d584a9e

File tree

6 files changed

+25
-2
lines changed

6 files changed

+25
-2
lines changed

docs/js-client-sdk.buildstoragekeysuffix.md

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## buildStorageKeySuffix() function
66

7+
Builds a storage key suffix from an API key.
8+
79
**Signature:**
810

911
```typescript
@@ -40,10 +42,14 @@ string
4042

4143
</td><td>
4244

45+
The API key to build the suffix from
46+
4347

4448
</td></tr>
4549
</tbody></table>
4650
**Returns:**
4751

4852
string
4953

54+
A string suffix for storage keys
55+

docs/js-client-sdk.iclientconfigsync.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -4,6 +4,8 @@
44

55
## IClientConfigSync interface
66

7+
Configuration interface for synchronous client initialization.
8+
79
**Signature:**
810

911
```typescript

docs/js-client-sdk.md

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -76,6 +76,8 @@ Description
7676

7777
</td><td>
7878

79+
Builds a storage key suffix from an API key.
80+
7981

8082
</td></tr>
8183
<tr><td>
@@ -181,6 +183,8 @@ Configuration for regular client initialization
181183

182184
</td><td>
183185

186+
Configuration interface for synchronous client initialization.
187+
184188

185189
</td></tr>
186190
<tr><td>

js-client-sdk.api.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ import { IAsyncStore } from '@eppo/js-client-sdk-common';
2020
import { IContainerExperiment } from '@eppo/js-client-sdk-common';
2121
import { ObfuscatedFlag } from '@eppo/js-client-sdk-common';
2222

23-
// @public (undocumented)
23+
// @public
2424
export function buildStorageKeySuffix(apiKey: string): string;
2525

2626
// Warning: (ae-forgotten-export) The symbol "IStringStorageEngine" needs to be exported by the entry point index.d.ts
@@ -125,7 +125,7 @@ export interface IClientConfig extends IBaseRequestConfig {
125125
useExpiredCache?: boolean;
126126
}
127127

128-
// @public (undocumented)
128+
// @public
129129
export interface IClientConfigSync {
130130
// (undocumented)
131131
assignmentLogger?: IAssignmentLogger;

src/chrome-storage-engine.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,6 +11,7 @@ import { IStringStorageEngine } from './string-valued.store';
1111
*
1212
* Note: this behaves a bit differently than local storage as the chrome storage API gets and sets
1313
* subsets of key-value pairs, so we have to dereference or re-specify the key.
14+
* @public
1415
*/
1516
export class ChromeStorageEngine implements IStringStorageEngine {
1617
private readonly contentsKey;

src/index.ts

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -34,6 +34,10 @@ import LocalStorageBackedNamedEventQueue from './events/local-storage-backed-nam
3434
import { IClientConfig, IPrecomputedClientConfig } from './i-client-config';
3535
import { sdkName, sdkVersion } from './sdk-data';
3636

37+
/**
38+
* Configuration interface for synchronous client initialization.
39+
* @public
40+
*/
3741
export interface IClientConfigSync {
3842
flagsConfiguration: Record<string, Flag | ObfuscatedFlag>;
3943

@@ -235,6 +239,12 @@ export class EppoJSClient extends EppoClient {
235239
}
236240
}
237241

242+
/**
243+
* Builds a storage key suffix from an API key.
244+
* @param apiKey - The API key to build the suffix from
245+
* @returns A string suffix for storage keys
246+
* @public
247+
*/
238248
export function buildStorageKeySuffix(apiKey: string): string {
239249
// Note that we use the first 8 characters of the API key to create per-API key persistent storages and caches
240250
return apiKey.replace(/\W/g, '').substring(0, 8);

0 commit comments

Comments
 (0)