chore(aws-amplify): add inline docs for Amplify configure and getConf…

…ig methods (#12487) * chore(aws-amplify): add inline docs for Amplify configure and getConfig methods * Apply suggestions from code review Co-authored-by: Chris F <[email protected]> --------- Co-authored-by: Chris F <[email protected]>
aws-amplify · Dec 1, 2023 · 38282bb · 38282bb
1 parent ef20ad8
commit 38282bb
Showing 1 changed file with 19 additions and 1 deletion.
diff --git a/packages/aws-amplify/src/initSingleton.ts b/packages/aws-amplify/src/initSingleton.ts
@@ -17,10 +17,22 @@ import {
 } from './auth/cognito';
 
 export const DefaultAmplify = {
+	/**
+	 * Configures Amplify with the {@link resourceConfig} and {@link libraryOptions}.
+	 *
+	 * @param resourceConfig The {@link ResourcesConfig} object that is typically imported from the
+	 * `amplifyconfiguration.json` file. It can also be an object literal created inline when calling `Amplify.configure`.
+	 * @param libraryOptions The {@link LibraryOptions} additional options for the library.
+	 *
+	 * @example
+	 * import config from './amplifyconfiguration.json';
+	 *
+	 * Amplify.configure(config);
+	 */
 	configure(
 		resourceConfig: ResourcesConfig | LegacyConfig,
 		libraryOptions?: LibraryOptions
-	) {
+	): void {
 		let resolvedResourceConfig: ResourcesConfig;
 
 		if (Object.keys(resourceConfig).some(key => key.startsWith('aws_'))) {
@@ -81,6 +93,12 @@ export const DefaultAmplify = {
 		// configured libraryOptions.
 		Amplify.configure(resolvedResourceConfig);
 	},
+	/**
+	 * Returns the {@link ResourcesConfig} object passed in as the `resourceConfig` parameter when calling
+	 * `Amplify.configure`.
+	 *
+	 * @returns An {@link ResourcesConfig} object.
+	 */
 	getConfig(): ResourcesConfig {
 		return Amplify.getConfig();
 	},