Skip to content

Commit b29d394

Browse files
authored
chore: improve fetchAuthSession docs (#14461)
1 parent d6f1422 commit b29d394

File tree

2 files changed

+4
-4
lines changed

2 files changed

+4
-4
lines changed

packages/core/src/singleton/Auth/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,8 +49,8 @@ export class AuthClass {
4949

5050
/**
5151
* Fetch the auth tokens, and the temporary AWS credentials and identity if they are configured. By default it
52-
* does not refresh the auth tokens or credentials if they are loaded in storage already. You can force a refresh
53-
* with `{ forceRefresh: true }` input.
52+
* will automatically refresh expired auth tokens if a valid refresh token is present. You can force a refresh
53+
* of non-expired tokens with `{ forceRefresh: true }` input.
5454
*
5555
* @param options - Options configuring the fetch behavior.
5656
*

packages/core/src/singleton/apis/fetchAuthSession.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,8 +8,8 @@ import { fetchAuthSession as fetchAuthSessionInternal } from './internal/fetchAu
88

99
/**
1010
* Fetch the auth session including the tokens and credentials if they are available. By default it
11-
* does not refresh the auth tokens or credentials if they are loaded in storage already. You can force a refresh
12-
* with `{ forceRefresh: true }` input.
11+
* will automatically refresh expired auth tokens if a valid refresh token is present. You can force a refresh
12+
* of non-expired tokens with `{ forceRefresh: true }` input.
1313
*
1414
* @param options - Options configuring the fetch behavior.
1515
* @throws {@link AuthError} - Throws error when session information cannot be refreshed.

0 commit comments

Comments
 (0)