Elaborate in API docs.

realm · May 1, 2024 · e042c35 · e042c35
1 parent c3064c8
commit e042c35
Showing 1 changed file with 6 additions and 0 deletions.
diff --git a/packages/realm/src/experimental/base-url.ts b/packages/realm/src/experimental/base-url.ts
@@ -22,12 +22,18 @@ declare module "../app-services/App" {
   interface App {
     /**
      * Get the current base URL used for sending requests to Atlas App Services.
+     * If an {@link App.updateBaseUrl | updateBaseUrl } operation is currently in
+     * progress, this value will not be updated with the new value until that
+     * operation has completed.
      * @experimental This feature is experimental and may be changed or removed.
      */
     get baseUrl(): string;
 
     /**
      * Update the base URL used for sending requests to Atlas App Services.
+     * If this operation fails, the app will continue to use the original base URL.
+     * If another {@link App} operation is started while this function is in progress,
+     * that request will use the original base URL location information.
      * @experimental This feature is experimental and may be changed or removed.
      */
     updateBaseUrl(newUrl: string): Promise<void>;