Reduce diff

Author: schmidt-sebastian

packages/firestore/exp/src/api/database.ts

@@ -361,15 +361,17 @@ export function clearIndexedDbPersistence(
 }
 
 /**
- * Waits until all currently pending writes for the active user have been acknowledged by the
- * backend.
+ * Waits until all currently pending writes for the active user have been
+ * acknowledged by the backend.
  *
- * The returned Promise resolves immediately if there are no outstanding writes. Otherwise, the
- * Promise waits for all previously issued writes (including those written in a previous app
- * session), but it does not wait for writes that were added after the method is called. If you
- * want to wait for additional writes, call `waitForPendingWrites()` again.
+ * The returned Promise resolves immediately if there are no outstanding writes.
+ * Otherwise, the Promise waits for all previously issued writes (including
+ * those written in a previous app session), but it does not wait for writes
+ * that were added after the method is called. If you want to wait for
+ * additional writes, call `waitForPendingWrites()` again.
  *
- * Any outstanding `waitForPendingWrites()` Promises are rejected during user changes.
+ * Any outstanding `waitForPendingWrites()` Promises are rejected during user
+ * changes.
  *
  * @return A Promise which resolves when all currently pending writes have been
  * acknowledged by the backend.
@@ -413,8 +415,7 @@ export function enableNetwork(firestore: FirebaseFirestore): Promise<void> {
  * results from cache, and any write operations will be queued until the network
  * is restored.
  *
- * @return A promise that is resolved once the network has been
- *   disabled.
+ * @return A promise that is resolved once the network has been disabled.
  */
 export function disableNetwork(firestore: FirebaseFirestore): Promise<void> {
   firestore._verifyNotTerminated();
@@ -430,22 +431,24 @@ export function disableNetwork(firestore: FirebaseFirestore): Promise<void> {
 /**
  * Terminates this Firestore instance.
  *
- * After calling `terminate()` only the `clearPersistence()` method may be used. Any other method
- * will throw a `FirestoreError`.
+ * After calling `terminate()` only the `clearPersistence()` method may be used.
+ * Any other method will throw a `FirestoreError`.
  *
  * To restart after termination, create a new instance of FirebaseFirestore with
  * `firebase.firestore()`.
  *
- * Termination does not cancel any pending writes, and any promises that are awaiting a response
- * from the server will not be resolved. If you have persistence enabled, the next time you
- * start this instance, it will resume sending these writes to the server.
+ * Termination does not cancel any pending writes, and any promises that are
+ * awaiting a response from the server will not be resolved. If you have
+ * persistence enabled, the next time you start this instance, it will resume
+ * sending these writes to the server.
  *
  * Note: Under normal circumstances, calling `terminate()` is not required. This
- * method is useful only when you want to force this instance to release all of its resources or
- * in combination with `clearPersistence()` to ensure that all local state is destroyed
- * between test runs.
+ * method is useful only when you want to force this instance to release all of
+ * its resources or in combination with `clearPersistence()` to ensure that all
+ * local state is destroyed between test runs.
  *
- * @return A promise that is resolved when the instance has been successfully terminated.
+ * @return A promise that is resolved when the instance has been successfully
+ * terminated.
  */
 export function terminate(firestore: FirebaseFirestore): Promise<void> {
   _removeServiceInstance(firestore.app, 'firestore-exp');

packages/firestore/exp/src/api/transaction.ts

@@ -81,15 +81,11 @@ export class Transaction extends LiteTransaction {
  * `FieldValue.arrayUnion()`, `FieldValue.arrayRemove()`, or
  * `FieldValue.increment()` inside a transaction counts as an additional write.
  *
- * @param updateFunction
- *   The function to execute within the transaction context.
- *
- * @return
- *   If the transaction completed successfully or was explicitly aborted
- *   (the `updateFunction` returned a failed promise),
- *   the promise returned by the updateFunction is returned here. Else, if the
- *   transaction failed, a rejected promise with the corresponding failure
- *   error will be returned.
+ * @param updateFunction The function to execute within the transaction context.
+ * @return If the transaction completed successfully or was explicitly aborted
+ * (the `updateFunction` returned a failed promise), the promise returned by the
+ * updateFunction is returned here. Else, if the transaction failed, a rejected
+ * promise with the corresponding failure error will be returned.
  */
 export function runTransaction<T>(
   firestore: FirebaseFirestore,

packages/firestore/exp/src/api/write_batch.ts

@@ -26,8 +26,8 @@ import { executeWrite } from './reference';
  * `FieldValue.arrayUnion()`, `FieldValue.arrayRemove()`, or
  * `FieldValue.increment()` inside a WriteBatch counts as an additional write.
  *
- * @return
- *   A `WriteBatch` that can be used to atomically execute multiple writes.
+ * @return A `WriteBatch` that can be used to atomically execute multiple
+ * writes.
  */
 export function writeBatch(firestore: FirebaseFirestore): WriteBatch {
   firestore._verifyNotTerminated();

packages/firestore/lite/src/api/bytes.ts

@@ -32,8 +32,7 @@ export class Bytes {
    * Creates a new Blob from the given Base64 string, converting it to
    * bytes.
    *
-   * @param base64
-   *   The Base64 string used to create the Blob object.
+   * @param base64 The Base64 string used to create the Blob object.
    */
   static fromBase64String(base64: string): Bytes {
     try {
@@ -49,8 +48,7 @@ export class Bytes {
   /**
    * Creates a new Blob from the given Uint8Array.
    *
-   * @param array
-   *   The Uint8Array used to create the Blob object.
+   * @param array The Uint8Array used to create the Blob object.
    */
   static fromUint8Array(array: Uint8Array): Bytes {
     return new Bytes(ByteString.fromUint8Array(array));
@@ -59,8 +57,7 @@ export class Bytes {
   /**
    * Returns the bytes of a Blob as a Base64-encoded string.
    *
-   * @return
-   *   The Base64-encoded string created from the Blob object.
+   * @return The Base64-encoded string created from the Blob object.
    */
   toBase64(): string {
     return this._byteString.toBase64();
@@ -69,8 +66,7 @@ export class Bytes {
   /**
    * Returns the bytes of a Blob in a new Uint8Array.
    *
-   * @return
-   *   The Uint8Array created from the Blob object.
+   * @return The Uint8Array created from the Blob object.
    */
   toUint8Array(): Uint8Array {
     return this._byteString.toUint8Array();

packages/firestore/lite/src/api/database.ts

@@ -152,6 +152,28 @@ export function getFirestore(app: FirebaseApp): FirebaseFirestore {
   ).getImmediate() as FirebaseFirestore;
 }
 
+/**
+ * Terminates this Firestore instance.
+ *
+ * After calling `terminate()` only the `clearPersistence()` method may be used.
+ * Any other method will throw a `FirestoreError`.
+ *
+ * To restart after termination, create a new instance of FirebaseFirestore with
+ * `firebase.firestore()`.
+ *
+ * Termination does not cancel any pending writes, and any promises that are
+ * awaiting a response from the server will not be resolved. If you have
+ * persistence enabled, the next time you start this instance, it will resume
+ * sending these writes to the server.
+ *
+ * Note: Under normal circumstances, calling `terminate()` is not required. This
+ * method is useful only when you want to force this instance to release all of
+ * its resources or in combination with `clearPersistence()` to ensure that all
+ * local state is destroyed between test runs.
+ *
+ * @return A promise that is resolved when the instance has been successfully
+ * terminated.
+ */
 export function terminate(firestore: FirebaseFirestore): Promise<void> {
   _removeServiceInstance(firestore.app, 'firestore/lite');
   return firestore._delete();

packages/firestore/lite/src/api/field_value.ts

@@ -56,11 +56,11 @@ export function serverTimestamp(): FieldValue {
 }
 
 /**
- * Returns a special value that can be used with `set()` or `update()` that tells
- * the server to union the given elements with any array value that already
- * exists on the server. Each specified element that doesn't already exist in
- * the array will be added to the end. If the field being modified is not
- * already an array it will be overwritten with an array containing exactly
+ * Returns a special value that can be used with `set()` or `update()` that
+ * tells the server to union the given elements with any array value that
+ * already exists on the server. Each specified element that doesn't already
+ * exist in the array will be added to the end. If the field being modified is
+ * not already an array it will be overwritten with an array containing exactly
  * the specified elements.
  *
  * @param elements The elements to union into the array.
@@ -74,11 +74,11 @@ export function arrayUnion(...elements: unknown[]): FieldValue {
 }
 
 /**
- * Returns a special value that can be used with `set()` or `update()` that tells
- * the server to remove the given elements from any array value that already
- * exists on the server. All instances of each element specified will be
- * removed from the array. If the field being modified is not already an
- * array it will be overwritten with an empty array.
+ * Returns a special value that can be used with `set()` or `update()` that
+ * tells the server to remove the given elements from any array value that
+ * already exists on the server. All instances of each element specified will be
+ * removed from the array. If the field being modified is not already an array
+ * it will be overwritten with an empty array.
  *
  * @param elements The elements to remove from the array.
  * @return The FieldValue sentinel for use in a call to `set()` or `update()`.
@@ -91,15 +91,15 @@ export function arrayRemove(...elements: unknown[]): FieldValue {
 }
 
 /**
- * Returns a special value that can be used with `set()` or `update()` that tells
- * the server to increment the field's current value by the given value.
+ * Returns a special value that can be used with `set()` or `update()` that
+ * tells the server to increment the field's current value by the given value.
  *
- * If either the operand or the current field value uses floating point precision,
- * all arithmetic follows IEEE 754 semantics. If both values are integers,
- * values outside of JavaScript's safe number range (`Number.MIN_SAFE_INTEGER` to
- * `Number.MAX_SAFE_INTEGER`) are also subject to precision loss. Furthermore,
- * once processed by the Firestore backend, all integer operations are capped
- * between -2^63 and 2^63-1.
+ * If either the operand or the current field value uses floating point
+ * precision, all arithmetic follows IEEE 754 semantics. If both values are
+ * integers, values outside of JavaScript's safe number range
+ * (`Number.MIN_SAFE_INTEGER` to `Number.MAX_SAFE_INTEGER`) are also subject to
+ * precision loss. Furthermore, once processed by the Firestore backend, all
+ * integer operations are capped between -2^63 and 2^63-1.
  *
  * If the current field value is not of type `number`, or if the field does not
  * yet exist, the transformation sets the field to the given value.