refactor(): pr feedback add ts doc

Esri · Nov 21, 2024 · 3e560de · 3e560de
1 parent 3bf973e
commit 3e560de
Show file tree

Hide file tree

Showing 2 changed files with 39 additions and 18 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/packages/common/src/users/_internal/UserUiSchemaSettings.ts b/packages/common/src/users/_internal/UserUiSchemaSettings.ts
@@ -287,6 +287,12 @@ async function _getCommunityOrEnterpriseAGOUrl(
   return orgUrl;
 }
 
+/**
+ * Fetches the portal settings in a fail-safe manner.
+ *
+ * @param context - The context containing the ArcGIS portal information.
+ * @returns A promise that resolves to the portal settings.
+ */
 export async function _getPortalSettings(
   context: IArcGISContext
 ): Promise<any> {