ra-core
Version:
Core components of react-admin, a frontend Framework for building admin applications on top of REST services, using ES6, React
23 lines • 1.29 kB
TypeScript
import { AuthProvider } from '../types';
/**
* A higher-order function which wraps an authProvider to handle refreshing authentication.
* This is useful when the authentication service supports a refresh token mechanism.
* The wrapped provider will call the refreshAuth function before
* calling the authProvider checkAuth, getIdentity and getPermissions methods.
*
* The refreshAuth function should return a Promise that resolves when the authentication token has been refreshed.
* It might throw an error if the refresh failed. In this case, react-admin will handle the error as usual.
*
* @param provider An authProvider
* @param refreshAuth A function that refreshes the authentication token if needed and returns a Promise.
* @returns A wrapped authProvider.
*
* @example
* import { addRefreshAuthToAuthProvider } from 'react-admin';
* import { authProvider } from './authProvider';
* import { refreshAuth } from './refreshAuth';
*
* const authProvider = addRefreshAuthToAuthProvider(authProvider, refreshAuth);
*/
export declare const addRefreshAuthToAuthProvider: <AuthProviderType extends AuthProvider = AuthProvider>(provider: AuthProviderType, refreshAuth: () => Promise<void>) => AuthProviderType;
//# sourceMappingURL=addRefreshAuthToAuthProvider.d.ts.map