@aws-amplify/core
Version:
Core category of aws-amplify
41 lines (40 loc) • 1.52 kB
TypeScript
import { AuthClass } from './Auth';
import { LegacyConfig, LibraryOptions, ResourcesConfig } from './types';
export declare class AmplifyClass {
resourcesConfig: ResourcesConfig;
libraryOptions: LibraryOptions;
/**
* Cross-category Auth utilities.
*
* @internal
*/
readonly Auth: AuthClass;
constructor();
/**
* Configures Amplify for use with your back-end resources.
*
* @remarks
* This API does not perform any merging of either `resourcesConfig` or `libraryOptions`. The most recently
* provided values will be used after configuration.
*
* @remarks
* `configure` can be used to specify additional library options where available for supported categories.
*
* @param resourceConfig - Back-end resource configuration. Typically provided via the `aws-exports.js` file.
* @param libraryOptions - Additional options for customizing the behavior of the library.
*/
configure(resourcesConfig: ResourcesConfig | LegacyConfig, libraryOptions?: LibraryOptions): void;
/**
* Provides access to the current back-end resource configuration for the Library.
*
* @returns Returns the immutable back-end resource configuration.
*/
getConfig(): Readonly<ResourcesConfig>;
}
/**
* The `Amplify` utility is used to configure the library.
*
* @remarks
* `Amplify` is responsible for orchestrating cross-category communication within the library.
*/
export declare const Amplify: AmplifyClass;