diff --git a/packages/core/src/singleton/Auth/index.ts b/packages/core/src/singleton/Auth/index.ts index f0f03481399..9c6d28abf35 100644 --- a/packages/core/src/singleton/Auth/index.ts +++ b/packages/core/src/singleton/Auth/index.ts @@ -49,8 +49,8 @@ export class AuthClass { /** * Fetch the auth tokens, and the temporary AWS credentials and identity if they are configured. By default it - * does not refresh the auth tokens or credentials if they are loaded in storage already. You can force a refresh - * with `{ forceRefresh: true }` input. + * will automatically refresh expired auth tokens if a valid refresh token is present. You can force a refresh + * of non-expired tokens with `{ forceRefresh: true }` input. * * @param options - Options configuring the fetch behavior. * diff --git a/packages/core/src/singleton/apis/fetchAuthSession.ts b/packages/core/src/singleton/apis/fetchAuthSession.ts index 1e7d4aa5f04..3971ceb561d 100644 --- a/packages/core/src/singleton/apis/fetchAuthSession.ts +++ b/packages/core/src/singleton/apis/fetchAuthSession.ts @@ -8,8 +8,8 @@ import { fetchAuthSession as fetchAuthSessionInternal } from './internal/fetchAu /** * Fetch the auth session including the tokens and credentials if they are available. By default it - * does not refresh the auth tokens or credentials if they are loaded in storage already. You can force a refresh - * with `{ forceRefresh: true }` input. + * will automatically refresh expired auth tokens if a valid refresh token is present. You can force a refresh + * of non-expired tokens with `{ forceRefresh: true }` input. * * @param options - Options configuring the fetch behavior. * @throws {@link AuthError} - Throws error when session information cannot be refreshed.