UNPKG

@aws-amplify/core

Version:
23 lines (19 loc) 914 B
// Copyright Amazon.com, Inc. or its affiliates. All Rights Reserved. // SPDX-License-Identifier: Apache-2.0 import { Amplify } from '../Amplify'; import { AuthSession, FetchAuthSessionOptions } from '../Auth/types'; import { fetchAuthSession as fetchAuthSessionInternal } from './internal/fetchAuthSession'; /** * 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. * * @param options - Options configuring the fetch behavior. * @throws {@link AuthError} - Throws error when session information cannot be refreshed. * @returns Promise<AuthSession> */ export const fetchAuthSession = ( options?: FetchAuthSessionOptions, ): Promise<AuthSession> => { return fetchAuthSessionInternal(Amplify, options); };