Capitalize and literalize Promise

Author: hsubox76

packages-exp/auth-exp/src/core/index.ts

@@ -50,7 +50,7 @@ export {
  *
  * @param auth - The {@link Auth} instance.
  * @param persistence - The {@link Persistence} to use.
- * @returns A promise that resolves once the persistence change has completed
+ * @returns A `Promise` that resolves once the persistence change has completed
  *
  * @public
  */

packages-exp/auth-exp/src/model/public_types.ts

@@ -795,7 +795,7 @@ export interface MultiFactorUser {
    * ```
    *
    * @param option - The multi-factor option to unenroll.
-   * @returns - A promise which resolves when the unenroll operation is complete.
+   * @returns - A `Promise` which resolves when the unenroll operation is complete.
    */
   unenroll(option: MultiFactorInfo | string): Promise<void>;
 }

packages-exp/remote-config-exp/src/api.ts

@@ -45,8 +45,8 @@ export function getRemoteConfig(app: FirebaseApp = getApp()): RemoteConfig {
 /**
  * Makes the last fetched config available to the getters.
  * @param remoteConfig - The {@link RemoteConfig} instance.
- * @returns A promise which resolves to true if the current call activated the fetched configs.
- * If the fetched configs were already activated, the promise will resolve to false.
+ * @returns A `Promise` which resolves to true if the current call activated the fetched configs.
+ * If the fetched configs were already activated, the `Promise` will resolve to false.
  *
  * @public
  */
@@ -77,7 +77,7 @@ export async function activate(remoteConfig: RemoteConfig): Promise<boolean> {
  * Ensures the last activated config are available to the getters.
  * @param remoteConfig - The {@link RemoteConfig} instance.
  *
- * @returns A promise that resolves when the last activated config is available to the getters.
+ * @returns A `Promise` that resolves when the last activated config is available to the getters.
  * @public
  */
 export function ensureInitialized(remoteConfig: RemoteConfig): Promise<void> {

packages-exp/remote-config-exp/src/api2.ts

@@ -27,8 +27,8 @@ import { getModularInstance } from '@firebase/util';
  *
  * @param remoteConfig - The {@link RemoteConfig} instance.
  *
- * @returns A promise which resolves to true if the current call activated the fetched configs.
- * If the fetched configs were already activated, the promise will resolve to false.
+ * @returns A `Promise` which resolves to true if the current call activated the fetched configs.
+ * If the fetched configs were already activated, the `Promise` will resolve to false.
  *
  * @public
  */

packages/database/src/exp/Reference_impl.ts

@@ -803,7 +803,7 @@ export function update(ref: DatabaseReference, values: object): Promise<void> {
  * Gets the most up-to-date result for this query.
  *
  * @param query - The query to run.
- * @returns A promise which resolves to the resulting DataSnapshot if a value is
+ * @returns A `Promise` which resolves to the resulting DataSnapshot if a value is
  * available, or rejects if the client is unable to return a value (e.g., if the
  * server is unreachable and there is nothing cached).
  */

packages/database/src/exp/Transaction.ts

@@ -88,7 +88,7 @@ export class TransactionResult {
  * transaction will be aborted and the data at this location will not be
  * modified.
  * @param options - An options object to configure transactions.
- * @returns A promise that can optionally be used instead of the `onComplete`
+ * @returns A `Promise` that can optionally be used instead of the `onComplete`
  * callback to handle success and failure.
  */
 export function runTransaction(

packages/firestore/src/exp/database.ts

@@ -226,7 +226,7 @@ export function configureFirestore(firestore: Firestore): void {
  * @param firestore - The {@link Firestore} instance to enable persistence for.
  * @param persistenceSettings - Optional settings object to configure
  * persistence.
- * @returns A promise that represents successfully enabling persistent storage.
+ * @returns A `Promise` that represents successfully enabling persistent storage.
  */
 export function enableIndexedDbPersistence(
   firestore: Firestore,
@@ -270,7 +270,7 @@ export function enableIndexedDbPersistence(
  *     persistence implementation.
  *
  * @param firestore - The {@link Firestore} instance to enable persistence for.
- * @returns A promise that represents successfully enabling persistent
+ * @returns A `Promise` that represents successfully enabling persistent
  * storage.
  */
 export function enableMultiTabIndexedDbPersistence(
@@ -384,7 +384,7 @@ function canFallbackFromIndexedDbError(
  * recommend not enabling persistence at all.
  *
  * @param firestore - The {@link Firestore} instance to clear persistence for.
- * @returns A promise that is resolved when the persistent storage is
+ * @returns A `Promise` that is resolved when the persistent storage is
  * cleared. Otherwise, the promise is rejected with an error.
  */
 export function clearIndexedDbPersistence(firestore: Firestore): Promise<void> {
@@ -423,7 +423,7 @@ export function clearIndexedDbPersistence(firestore: Firestore): Promise<void> {
  * Any outstanding `waitForPendingWrites()` promises are rejected during user
  * changes.
  *
- * @returns A promise which resolves when all currently pending writes have been
+ * @returns A `Promise` which resolves when all currently pending writes have been
  * acknowledged by the backend.
  */
 export function waitForPendingWrites(firestore: Firestore): Promise<void> {
@@ -436,7 +436,7 @@ export function waitForPendingWrites(firestore: Firestore): Promise<void> {
  * Re-enables use of the network for this {@link Firestore} instance after a prior
  * call to {@link disableNetwork}.
  *
- * @returns A promise that is resolved once the network has been enabled.
+ * @returns A `Promise` that is resolved once the network has been enabled.
  */
 export function enableNetwork(firestore: Firestore): Promise<void> {
   firestore = cast(firestore, Firestore);
@@ -450,7 +450,7 @@ export function enableNetwork(firestore: Firestore): Promise<void> {
  * `getDoc()` or `getDocs()` calls will return results from cache, and any write
  * operations will be queued until the network is restored.
  *
- * @returns A promise that is resolved once the network has been disabled.
+ * @returns A `Promise` that is resolved once the network has been disabled.
  */
 export function disableNetwork(firestore: Firestore): Promise<void> {
   firestore = cast(firestore, Firestore);
@@ -477,7 +477,7 @@ export function disableNetwork(firestore: Firestore): Promise<void> {
  * of its resources or in combination with `clearIndexedDbPersistence()` to
  * ensure that all local state is destroyed between test runs.
  *
- * @returns A promise that is resolved when the instance has been successfully
+ * @returns A `Promise` that is resolved when the instance has been successfully
  * terminated.
  */
 export function terminate(firestore: Firestore): Promise<void> {

packages/firestore/src/exp/reference_impl.ts

@@ -121,7 +121,7 @@ export class ExpUserDataWriter extends AbstractUserDataWriter {
  * Reads the document referred to by this `DocumentReference` from cache.
  * Returns an error if the document is not currently cached.
  *
- * @returns A promise resolved with a `DocumentSnapshot` containing the
+ * @returns A `Promise` resolved with a `DocumentSnapshot` containing the
  * current document contents.
  */
 export function getDocFromCache<T>(
@@ -152,7 +152,7 @@ export function getDocFromCache<T>(
  * Reads the document referred to by this `DocumentReference` from the server.
  * Returns an error if the network is not available.
  *
- * @returns A promise resolved with a `DocumentSnapshot` containing the
+ * @returns A `Promise` resolved with a `DocumentSnapshot` containing the
  * current document contents.
  */
 export function getDocFromServer<T>(
@@ -175,7 +175,7 @@ export function getDocFromServer<T>(
  * you are offline and the server cannot be reached. To specify this behavior,
  * invoke {@link getDocsFromCache} or {@link getDocsFromServer}.
  *
- * @returns A promise that will be resolved with the results of the query.
+ * @returns A `Promise` that will be resolved with the results of the query.
  */
 export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>> {
   query = cast<Query<T>>(query, Query);
@@ -196,7 +196,7 @@ export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>> {
  * Executes the query and returns the results as a `QuerySnapshot` from cache.
  * Returns an error if the document is not currently cached.
  *
- * @returns A promise that will be resolved with the results of the query.
+ * @returns A `Promise` that will be resolved with the results of the query.
  */
 export function getDocsFromCache<T>(
   query: Query<T>
@@ -215,7 +215,7 @@ export function getDocsFromCache<T>(
  * Executes the query and returns the results as a `QuerySnapshot` from the
  * server. Returns an error if the network is not available.
  *
- * @returns A promise that will be resolved with the results of the query.
+ * @returns A `Promise` that will be resolved with the results of the query.
  */
 export function getDocsFromServer<T>(
   query: Query<T>
@@ -238,7 +238,7 @@ export function getDocsFromServer<T>(
  *
  * @param reference - A reference to the document to write.
  * @param data - A map of the fields and values for the document.
- * @returns A promise resolved once the data has been successfully written
+ * @returns A `Promise` resolved once the data has been successfully written
  * to the backend (note that it won't resolve while you're offline).
  */
 export function setDoc<T>(
@@ -297,7 +297,7 @@ export function setDoc<T>(
  * @param data - An object containing the fields and values with which to
  * update the document. Fields can contain dots to reference nested fields
  * within the document.
- * @returns A promise resolved once the data has been successfully written
+ * @returns A `Promise` resolved once the data has been successfully written
  * to the backend (note that it won't resolve while you're offline).
  */
 export function updateDoc(
@@ -316,7 +316,7 @@ export function updateDoc(
  * @param field - The first field to update.
  * @param value - The first value.
  * @param moreFieldsAndValues - Additional key value pairs.
- * @returns A promise resolved once the data has been successfully written
+ * @returns A `Promise` resolved once the data has been successfully written
  * to the backend (note that it won't resolve while you're offline).
  */
 export function updateDoc(
@@ -387,7 +387,7 @@ export function deleteDoc(
  *
  * @param reference - A reference to the collection to add this document to.
  * @param data - An Object containing the data for the new document.
- * @returns A promise resolved with a `DocumentReference` pointing to the
+ * @returns A `Promise` resolved with a `DocumentReference` pointing to the
  * newly created document after it has been written to the backend (Note that it
  * won't resolve while you're offline).
  */

packages/firestore/src/lite/database.ts

@@ -303,7 +303,7 @@ export function connectFirestoreEmulator(
  * ensure that all local state is destroyed between test runs.
  *
  * @param firestore - The `Firestore` instance to terminate.
- * @returns A promise that is resolved when the instance has been successfully
+ * @returns A `Promise` that is resolved when the instance has been successfully
  * terminated.
  */
 export function terminate(firestore: Firestore): Promise<void> {

packages/firestore/src/lite/reference_impl.ts

@@ -192,7 +192,7 @@ export function getDocs<T>(query: Query<T>): Promise<QuerySnapshot<T>> {
  *
  * @param reference - A reference to the document to write.
  * @param data - A map of the fields and values for the document.
- * @returns A promise resolved once the data has been successfully written
+ * @returns A `Promise` resolved once the data has been successfully written
  * to the backend.
  */
 export function setDoc<T>(
@@ -212,7 +212,7 @@ export function setDoc<T>(
  * @param reference - A reference to the document to write.
  * @param data - A map of the fields and values for the document.
  * @param options - An object to configure the set behavior.
- * @returns A promise resolved once the data has been successfully written
+ * @returns A `Promise` resolved once the data has been successfully written
  * to the backend.
  */
 export function setDoc<T>(
@@ -261,7 +261,7 @@ export function setDoc<T>(
  * @param data - An object containing the fields and values with which to
  * update the document. Fields can contain dots to reference nested fields
  * within the document.
- * @returns A promise resolved once the data has been successfully written
+ * @returns A `Promise` resolved once the data has been successfully written
  * to the backend.
  */
 export function updateDoc(
@@ -285,7 +285,7 @@ export function updateDoc(
  * @param field - The first field to update.
  * @param value - The first value.
  * @param moreFieldsAndValues - Additional key value pairs.
- * @returns A promise resolved once the data has been successfully written
+ * @returns A `Promise` resolved once the data has been successfully written
  * to the backend.
  */
 export function updateDoc(
@@ -344,7 +344,7 @@ export function updateDoc(
  * until the client is online, use the full Firestore SDK.
  *
  * @param reference - A reference to the document to delete.
- * @returns A promise resolved once the document has been successfully
+ * @returns A `Promise` resolved once the document has been successfully
  * deleted from the backend.
  */
 export function deleteDoc(
@@ -368,7 +368,7 @@ export function deleteDoc(
  *
  * @param reference - A reference to the collection to add this document to.
  * @param data - An Object containing the data for the new document.
- * @returns A promise resolved with a `DocumentReference` pointing to the
+ * @returns A `Promise` resolved with a `DocumentReference` pointing to the
  * newly created document after it has been written to the backend.
  */
 export function addDoc<T>(

packages/firestore/src/lite/write_batch.ts

@@ -205,7 +205,7 @@ export class WriteBatch {
    * write fails. If you would like to see local modifications or buffer writes
    * until the client is online, use the full Firestore SDK.
    *
-   * @returns A promise resolved once all of the writes in the batch have been
+   * @returns A `Promise` resolved once all of the writes in the batch have been
    * successfully written to the backend as an atomic unit (note that it won't
    * resolve while you're offline).
    */

packages/firestore/src/local/persistence.ts

@@ -235,7 +235,7 @@ export interface Persistence {
    * be acquired and the returned promise will be rejected with a
    * FAILED_PRECONDITION error.
    * @param transactionOperation - The operation to run inside a transaction.
-   * @returns A promise that is resolved once the transaction completes.
+   * @returns A `Promise` that is resolved once the transaction completes.
    */
   runTransaction<T>(
     action: string,

packages/firestore/src/local/simple_db.ts

@@ -55,7 +55,7 @@ export class SimpleDbTransaction {
   private aborted = false;
 
   /**
-   * A promise that resolves with the result of the IndexedDb transaction.
+   * A `Promise` that resolves with the result of the IndexedDb transaction.
    */
   private readonly completionDeferred = new Deferred<void>();
 

packages/storage/compat/reference.ts

@@ -185,7 +185,7 @@ export class ReferenceCompat
   }
 
   /**
-   * A promise that resolves with the metadata for this object. If this
+   * A `Promise` that resolves with the metadata for this object. If this
    * object doesn't exist or metadata cannot be retreived, the promise is
    * rejected.
    */
@@ -198,7 +198,7 @@ export class ReferenceCompat
    * @param metadata - The new metadata for the object.
    * Only values that have been explicitly set will be changed. Explicitly
    * setting a value to null will remove the metadata.
-   * @returns A promise that resolves
+   * @returns A `Promise` that resolves
    * with the new metadata for this object.
    * @see firebaseStorage.Reference.prototype.getMetadata
    */
@@ -212,7 +212,7 @@ export class ReferenceCompat
   }
 
   /**
-   * @returns A promise that resolves with the download
+   * @returns A `Promise` that resolves with the download
    * URL for this object.
    */
   getDownloadURL(): Promise<string> {
@@ -221,7 +221,7 @@ export class ReferenceCompat
 
   /**
    * Deletes the object at this location.
-   * @returns A promise that resolves if the deletion succeeds.
+   * @returns A `Promise` that resolves if the deletion succeeds.
    */
   delete(): Promise<void> {
     this._throwIfRoot('delete');

packages/storage/exp/api.ts

@@ -132,7 +132,7 @@ export function uploadBytesResumable(
 }
 
 /**
- * A promise that resolves with the metadata for this object. If this
+ * A `Promise` that resolves with the metadata for this object. If this
  * object doesn't exist or metadata cannot be retreived, the promise is
  * rejected.
  * @public
@@ -150,7 +150,7 @@ export function getMetadata(ref: StorageReference): Promise<FullMetadata> {
  * @param metadata - The new metadata for the object.
  *     Only values that have been explicitly set will be changed. Explicitly
  *     setting a value to null will remove the metadata.
- * @returns A promise that resolves with the new metadata for this object.
+ * @returns A `Promise` that resolves with the new metadata for this object.
  */
 export function updateMetadata(
   ref: StorageReference,
@@ -180,7 +180,7 @@ export function updateMetadata(
  *
  * @param ref - {@link StorageReference} to get list from.
  * @param options - See {@link ListOptions} for details.
- * @returns A promise that resolves with the items and prefixes.
+ * @returns A `Promise` that resolves with the items and prefixes.
  *      `prefixes` contains references to sub-folders and `items`
  *      contains references to objects in this folder. `nextPageToken`
  *      can be used to get the rest of the results.
@@ -207,7 +207,7 @@ export function list(
  * @public
  * @param ref - {@link StorageReference} to get list from.
  *
- * @returns A promise that resolves with all the items and prefixes under
+ * @returns A `Promise` that resolves with all the items and prefixes under
  *      the current storage reference. `prefixes` contains references to
  *      sub-directories and `items` contains references to objects in this
  *      folder. `nextPageToken` is never returned.
@@ -221,7 +221,7 @@ export function listAll(ref: StorageReference): Promise<ListResult> {
  * Returns the download URL for the given {@link StorageReference}.
  * @public
  * @param ref - {@link StorageReference} to get the download URL for.
- * @returns A promise that resolves with the download
+ * @returns A `Promise` that resolves with the download
  *     URL for this object.
  */
 export function getDownloadURL(ref: StorageReference): Promise<string> {
@@ -233,7 +233,7 @@ export function getDownloadURL(ref: StorageReference): Promise<string> {
  * Deletes the object at this location.
  * @public
  * @param ref - {@link StorageReference} for object to delete.
- * @returns A promise that resolves if the deletion succeeds.
+ * @returns A `Promise` that resolves if the deletion succeeds.
  */
 export function deleteObject(ref: StorageReference): Promise<void> {
   ref = getModularInstance(ref);