Skip to content

Commit 71ac5c4

Browse files
committed
docs: add better comments to IterableAuthManager
1 parent 1dbd4e2 commit 71ac5c4

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

src/core/classes/IterableAuthManager.ts

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -6,9 +6,7 @@ import { IterableAuthResponse } from './IterableAuthResponse';
66
*
77
* @example
88
* ```typescript
9-
* const config = new IterableConfig();
10-
* const logger = new IterableLogger(config);
11-
* const authManager = new IterableAuthManager(logger);
9+
* const authManager = new IterableAuthManager();
1210
* ```
1311
*/
1412
export class IterableAuthManager {
@@ -31,6 +29,12 @@ export class IterableAuthManager {
3129
* Pass along an auth token to the SDK.
3230
*
3331
* @param authToken - The auth token to pass along
32+
*
33+
* @example
34+
* ```typescript
35+
* const authManager = new IterableAuthManager();
36+
* authManager.passAlongAuthToken(MY_AUTH_TOKEN);
37+
* ```
3438
*/
3539
passAlongAuthToken(
3640
authToken: string | null | undefined

0 commit comments

Comments
 (0)