@dereekb/firebase 13.11.14 → 13.11.15

package/src/lib/common/firestore/collection/collection.d.ts

@@ -154,10 +154,11 @@ export type FirestoreModelTypes<I extends FirestoreModelIdentity> = I extends Fi
 /**
  * Creates a FirestoreModelIdentity value.
  *
- * @param parentOrModelName The parent FirestoreModelIdentity or the model name if not nested
- * @param collectionNameOrModelName The collection name or the model name if not nested
- * @param inputCollectionName Optional explicit collection name (used when parent is provided)
- * @returns The created FirestoreModelIdentity
+ * @param parentOrModelName Parent identity when nested, otherwise the model name.
+ * @param collectionNameOrModelName Collection name when a parent is provided, otherwise the model name.
+ * @param modelName Model name when a parent and collection name are both supplied.
+ * @param inputCollectionName Explicit collection name; only meaningful alongside a parent.
+ * @returns Identity value describing the model and its collection placement.
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelIdentity<M extends FirestoreModelType>(modelName: M): RootFirestoreModelIdentity<M, FirestoreModelDefaultCollectionName<M>>;
@@ -188,8 +189,10 @@ export interface FirestoreModelTypeRef<M extends FirestoreModelType = FirestoreM
 /**
  * Reads the FirestoreModelType from a FirestoreModelType or FirestoreModelTypeRef.
  *
- * @param modelTypeInput
- * @returns
+ * @param modelTypeInput - Either a raw `FirestoreModelType` string or an object exposing one via `.modelType`.
+ * @returns The resolved `FirestoreModelType` string.
+ * @throws {Error} When the resolved model type is empty.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelType(modelTypeInput: FirestoreModelType | FirestoreModelTypeRef): FirestoreModelType;
@@ -305,8 +308,8 @@ export declare const FIRESTORE_MODEL_ID_REGEX: RegExp;
 /**
  * Returns true if the input string is a FirestoreModelId.
  *
- * @param input - The string to test
- * @returns True if the input is a valid FirestoreModelId
+ * @param input - Candidate identifier to validate.
+ * @returns True when the input matches the Firestore ID format.
  */
 export declare function isFirestoreModelId(input: string | FirestoreModelId): input is FirestoreModelId;
 /**
@@ -349,15 +352,15 @@ export declare const FIRESTORE_MODEL_KEY_REGEX_STRICT: RegExp;
 /**
  * Returns true if the input string is a FirestoreModelKey.
  *
- * @param input - The string to test
- * @returns True if the input is a valid FirestoreModelKey
+ * @param input - Candidate path to validate.
+ * @returns True when the input matches the Firestore key format.
  */
 export declare function isFirestoreModelKey(input: string | FirestoreModelKey): input is FirestoreModelKey;
 /**
  * Returns true if the input string is a FirestoreModelId or a FirestoreModelKey.
  *
- * @param input - The string to test
- * @returns True if the input is a valid FirestoreModelId or FirestoreModelKey
+ * @param input - Candidate identifier or path to validate.
+ * @returns True when the input matches either the ID or key format.
  */
 export declare function isFirestoreModelIdOrKey(input: string | FirestoreModelId | FirestoreModelKey): input is FirestoreModelId | FirestoreModelKey;
 /**
@@ -370,11 +373,12 @@ export type FirestoreModelKeyPart<C extends FirestoreCollectionName = FirestoreC
 export type FirestoreCollectionModelKeyPart<N extends FirestoreCollectionNameRef = FirestoreCollectionNameRef, K extends FirestoreModelId = FirestoreModelId> = N extends FirestoreCollectionNameRef<infer C> ? FirestoreModelKeyPart<C, K> : never;
 export type FirestoreCollectionModelKey<N extends FirestoreCollectionNameRef = FirestoreCollectionNameRef, K extends FirestoreModelId = FirestoreModelId> = FirestoreCollectionModelKeyPart<N, K>;
 /**
- * Creates a firestoreModelKeyPart
+ * Creates a firestoreModelKeyPart.
  *
  * @param identity
  * @param id
  * @returns
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyPart<N extends FirestoreCollectionNameRef, K extends FirestoreModelId = FirestoreModelId>(identity: N, id: K): FirestoreCollectionModelKeyPart<N, K>;
@@ -393,8 +397,9 @@ export type FirestoreModelKeyFactory<I extends RootFirestoreModelIdentity, K ext
 /**
  * Creates a FirestoreModelKeyFactory for the input root identity.
  *
- * @param identity - The root FirestoreModelIdentity to bind the factory to
- * @returns A factory function that creates FirestoreModelKey values for the given identity and a provided id
+ * @param identity - The root FirestoreModelIdentity to bind the factory to.
+ * @returns A factory function that creates FirestoreModelKey values for the given identity and a provided id.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyFactory<I extends RootFirestoreModelIdentity, K extends FirestoreModelId = FirestoreModelId>(identity: I): (id: K) => FirestoreCollectionModelKeyPart<I, K>;
@@ -445,8 +450,9 @@ export type FirestoreModelCollectionAndIdPairObject = Record<FirestoreCollection
 /**
  * Converts a FirestoreModelKey or reference into a record mapping each collection name to its document id.
  *
- * @param input - The FirestoreModelKey, DocumentReferenceRef, or FirestoreModelKeyRef to convert
- * @returns An object mapping collection names to document ids, or undefined if the key is unavailable
+ * @param input - The FirestoreModelKey, DocumentReferenceRef, or FirestoreModelKeyRef to convert.
+ * @returns An object mapping collection names to document ids, or undefined if the key is unavailable.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyPairObject(input: FirestoreModelKey | DocumentReferenceRef<unknown> | FirestoreModelKeyRef): Maybe<FirestoreModelCollectionAndIdPairObject>;
@@ -464,26 +470,29 @@ export type FirestoreModelCollectionTypeArrayName = string;
 /**
  * Returns the FirestoreCollectionType derived from the input FirestoreModelKey.
  *
- * @param input - The key or reference to extract the collection type from
- * @returns The FirestoreCollectionType string, or undefined if the key is unavailable
+ * @param input - The key or reference to extract the collection type from.
+ * @returns The FirestoreCollectionType string, or undefined if the key is unavailable.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyCollectionType<T = unknown>(input: ReadFirestoreModelKeyInput<T>): Maybe<FirestoreCollectionType>;
 /**
  * Returns the collection type array name string derived from the input key, joined by the given separator.
  *
- * @param input - The key or reference to extract collection names from
- * @param separator - The separator to join collection names with; defaults to the Firestore collection name separator
- * @returns The joined collection type array name string, or undefined if the key is unavailable
+ * @param input - The key or reference to extract collection names from.
+ * @param separator - The separator to join collection names with; defaults to the Firestore collection name separator.
+ * @returns The joined collection type array name string, or undefined if the key is unavailable.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyCollectionTypeArrayName<T = unknown>(input: ReadFirestoreModelKeyInput<T>, separator?: string): Maybe<FirestoreModelCollectionTypeArrayName>;
 /**
  * Returns the collection type array name string derived from a FirestoreModelIdentity, joined by the given separator.
  *
- * @param input - The FirestoreModelIdentity to derive collection names from
- * @param separator - The separator to join collection names with; defaults to the Firestore collection name separator
- * @returns The joined collection type array name string
+ * @param input - The FirestoreModelIdentity to derive collection names from.
+ * @param separator - The separator to join collection names with; defaults to the Firestore collection name separator.
+ * @returns The joined collection type array name string.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreIdentityTypeArrayName(input: FirestoreModelIdentity, separator?: string): FirestoreModelCollectionTypeArrayName;
@@ -491,16 +500,19 @@ export type FirestoreModelCollectionTypeArray = FirestoreCollectionName[];
 /**
  * Returns an ordered array of collection names derived from a FirestoreModelIdentity, from root to leaf.
  *
- * @param input - The FirestoreModelIdentity to traverse
- * @returns An array of FirestoreCollectionName values ordered from root to leaf
+ * @param input - Identity whose ancestor chain is walked.
+ * @returns Collection names ordered from root to leaf.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreIdentityTypeArray(input: FirestoreModelIdentity): FirestoreModelCollectionTypeArray;
 /**
  * Returns an ordered array of collection names derived from the input FirestoreModelKey.
  *
- * @param input - The key or reference to extract collection names from
- * @returns An array of FirestoreCollectionName values, or undefined if the key is unavailable
+ * @param input - Key or reference whose path segments are parsed.
+ * @returns Collection names extracted from the key, or undefined when no key is available.
+ * @throws {Error} When the decoded key has an odd number of path segments (e.g. a collection ref instead of a document ref).
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyCollectionTypeArray<T = unknown>(input: ReadFirestoreModelKeyInput<T>): Maybe<FirestoreModelCollectionTypeArray>;
@@ -509,26 +521,29 @@ export interface FirestoreModelCollectionAndIdPair extends FirestoreModelIdRef,
 /**
  * Returns the collection name of the input key.
  *
- * @param input - The key or reference to extract the collection name from
- * @returns The FirestoreCollectionName from the deepest key pair, or undefined if unavailable
+ * @param input - The key or reference to extract the collection name from.
+ * @returns The FirestoreCollectionName from the deepest key pair, or undefined if unavailable.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyCollectionName<T = unknown>(input: ReadFirestoreModelKeyInput<T>): Maybe<FirestoreCollectionName>;
 /**
  * Returns the parent model key from up the specified amount of levels.
  *
- * @param input - The key or reference to extract the parent key from
- * @param maxLevelsUp - The number of levels to traverse up the key hierarchy; defaults to 1
- * @returns The parent FirestoreModelKey, or undefined if no parent exists
+ * @param input - Key or reference whose ancestor is located.
+ * @param maxLevelsUp - How many hierarchy levels to climb; defaults to 1.
+ * @returns Parent key, or undefined when no parent exists at that depth.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyParentKey<T = unknown>(input: ReadFirestoreModelKeyInput<T>, maxLevelsUp?: number): Maybe<FirestoreModelKey>;
 /**
  * Returns the collection/id pair array truncated by the specified number of levels from the end.
  *
- * @param input - The key or reference to extract pairs from
- * @param maxLevelsUp - The number of levels to remove from the end; defaults to 1
- * @returns An array of FirestoreModelCollectionAndIdPair values up to the parent level, or undefined if unavailable
+ * @param input - Key or reference whose pair list is truncated.
+ * @param maxLevelsUp - How many trailing pairs to drop; defaults to 1.
+ * @returns Pair list down to the requested ancestor level, or undefined when unavailable.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyParentKeyPartPairs<T = unknown>(input: ReadFirestoreModelKeyInput<T>, maxLevelsUp?: number): Maybe<FirestoreModelCollectionAndIdPair[]>;
@@ -543,8 +558,10 @@ export declare function firestoreModelKeyTypePair<T = unknown>(input: ReadFirest
 /**
  * Parses a FirestoreModelKey into an ordered array of collection/id pair objects.
  *
- * @param input - The key or reference to parse
- * @returns An array of FirestoreModelCollectionAndIdPair values, or undefined if the key is unavailable
+ * @param input - Key or reference whose path segments are decoded.
+ * @returns Ordered collection/id pairs decoded from the key, or undefined when no key is available.
+ * @throws {Error} When the decoded key has an odd number of path segments (e.g. a collection ref instead of a document ref).
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelKeyPartPairs<T = unknown>(input: ReadFirestoreModelKeyInput<T>): Maybe<FirestoreModelCollectionAndIdPair[]>;
@@ -588,7 +605,8 @@ export type FirestoreDummyModelKey = typeof FIRESTORE_DUMMY_MODEL_KEY;
  * It's useful in testing scenarios or when initializing structures that
  * require a key before one is available.
  *
- * @returns The dummy model key constant
+ * @returns The dummy model key constant.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreDummyKey(): FirestoreDummyModelKey;
@@ -663,10 +681,12 @@ export interface FirestoreCollectionRef<T, D extends FirestoreDocument<T> = Fire
  * 3. Query factory for building typed queries
  * 4. Iteration utilities for paginated access
  *
+ * @param inputConfig - Configuration for the collection.
+ * @returns A fully configured FirestoreCollection instance.
+ *
  * @template T - The data type of documents in the collection
  * @template D - The FirestoreDocument type that wraps the data
- * @param inputConfig - Configuration for the collection
- * @returns A fully configured FirestoreCollection instance
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makeFirestoreCollection<T, D extends FirestoreDocument<T>>(inputConfig: FirestoreCollectionConfig<T, D>): FirestoreCollection<T, D>;

package/src/lib/common/firestore/collection/collection.group.d.ts

@@ -48,10 +48,12 @@ export interface FirestoreCollectionGroup<T, D extends FirestoreDocument<T> = Fi
  * which is particularly useful for modeling relationships that can exist at different points
  * in the document hierarchy.
  *
+ * @param config - Configuration for the collection group.
+ * @returns A fully configured FirestoreCollectionGroup instance.
+ *
  * @template T - The data type of the documents in the collection group
  * @template D - The FirestoreDocument type that wraps the data
- * @param config - Configuration for the collection group
- * @returns A fully configured FirestoreCollectionGroup instance
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makeFirestoreCollectionGroup<T, D extends FirestoreDocument<T>>(config: FirestoreCollectionGroupConfig<T, D>): FirestoreCollectionGroup<T, D>;

package/src/lib/common/firestore/collection/collection.query.d.ts

@@ -191,23 +191,26 @@ export interface FirestoreCollectionQueryFactory<T, D extends FirestoreDocument<
  * by wrapping standard query operations with document loading capabilities. It transforms
  * query results from raw Firestore snapshots into fully-typed document model instances.
  *
+ * @param queryFactory - The base query factory for creating raw Firestore queries.
+ * @param accessorContext - The document accessor context for loading and converting documents.
+ * @returns A collection query factory for creating document-aware queries.
+ *
  * @template T - The data type of the documents
  * @template D - The FirestoreDocument type that wraps the data
- * @param queryFactory - The base query factory for creating raw Firestore queries
- * @param accessorContext - The document accessor context for loading and converting documents
- * @returns A collection query factory for creating document-aware queries
  *
  * @example
+ * ```ts
  * // Creating a collection query factory
  * const userQueryFactory = firestoreCollectionQueryFactory(
  *   userQueryFactory,  // Base query factory
  *   userAccessorContext  // Document accessor context
  * );
- *
  * // Using the factory to create and execute a query
  * const activeUsers = await userQueryFactory
  *   .queryDocument(where('status', '==', 'active'))
  *   .getDocs();
+ * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreCollectionQueryFactory<T, D extends FirestoreDocument<T>>(queryFactory: FirestoreQueryFactory<T>, accessorContext: LimitedFirestoreDocumentAccessorContextExtension<T, D>): FirestoreCollectionQueryFactory<T, D>;

package/src/lib/common/firestore/collection/collection.single.d.ts

@@ -43,10 +43,12 @@ export interface RootSingleItemFirestoreCollection<T, D extends FirestoreDocumen
  * with a single document. Useful for application settings, configuration,
  * or any singleton-like data structures that are stored in Firestore.
  *
+ * @param config - Configuration for the single document collection.
+ * @returns A RootSingleItemFirestoreCollection instance configured for the specified document.
+ *
  * @template T - The data type of the document
  * @template D - The FirestoreDocument type, defaults to FirestoreDocument<T>
- * @param config - Configuration for the single document collection
- * @returns A RootSingleItemFirestoreCollection instance configured for the specified document
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makeRootSingleItemFirestoreCollection<T, D extends FirestoreDocument<T> = FirestoreDocument<T>>(config: RootSingleItemFirestoreCollectionConfig<T, D>): RootSingleItemFirestoreCollection<T, D>;

package/src/lib/common/firestore/collection/collection.util.d.ts

@@ -7,14 +7,15 @@ import { type FirestoreModelId } from './collection';
  * that satisfies Firestore's document ID constraints. This encoding is one-way; the
  * original email cannot be recovered from the result.
  *
- * @param emailAddress - The email address to convert
- * @returns A Firestore-safe document ID derived from the email
+ * @param emailAddress - The email address to convert.
+ * @returns A Firestore-safe document ID derived from the email.
  *
  * @example
  * ```ts
  * const id = firestoreModelIdFromEmail('user@example.com');
  * // id === 'userAAAexamplecom'
  * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreModelIdFromEmail(emailAddress: EmailAddress): FirestoreModelId;

package/src/lib/common/firestore/collection/subcollection.d.ts

@@ -91,12 +91,14 @@ export type FirestoreCollectionWithParentFactory<T, PT, D extends FirestoreDocum
  * parent document. The subcollection inherits all the capabilities of a standard
  * collection while also providing access to its parent document context.
  *
+ * @param config - Configuration for the subcollection, including the parent document reference.
+ * @returns A subcollection instance linked to the specified parent document.
+ *
  * @template T - The data type of documents in the subcollection
  * @template PT - The data type of the parent document
  * @template D - The document type for documents in the subcollection, defaults to FirestoreDocument<T>
  * @template PD - The document type for the parent document, defaults to FirestoreDocument<PT>
- * @param config - Configuration for the subcollection, including the parent document reference
- * @returns A subcollection instance linked to the specified parent document
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makeFirestoreCollectionWithParent<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>>(config: FirestoreCollectionWithParentConfig<T, PT, D, PD>): FirestoreCollectionWithParent<T, PT, D, PD>;

package/src/lib/common/firestore/collection/subcollection.paged.d.ts

@@ -199,8 +199,10 @@ export interface PagedItemFirestoreCollection<T, PT, D extends FirestoreDocument
  * handled by the paged accessor's {@link PagedItemConverter}) and `c` is the
  * denormalized count.
  *
+ * @returns A snapshot converter for {@link PagedItemPageData}<T>.
+ *
  * @template T - The item type stored across pages
- * @returns A snapshot converter for {@link PagedItemPageData}<T>
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function defaultPagedItemPageDataConverter<T>(): SnapshotConverterFunctions<PagedItemPageData<T>>;
@@ -215,12 +217,14 @@ export declare function defaultPagedItemPageDataConverter<T>(): SnapshotConverte
  * default {@link defaultPagedItemPageDataConverter} is used so consumers don't
  * have to model the envelope shape themselves.
  *
+ * @param config - Paged collection configuration.
+ * @returns A configured paged subcollection.
+ *
  * @template T - The item type stored across pages
  * @template PT - The parent document data type
  * @template D - The page document type
  * @template PD - The parent document type
- * @param config - Paged collection configuration
- * @returns A configured paged subcollection
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makePagedItemFirestoreCollection<T, PT, D extends FirestoreDocument<PagedItemPageData<T>> = FirestoreDocument<PagedItemPageData<T>>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>>(config: PagedItemFirestoreCollectionConfig<T, PT, D, PD>): PagedItemFirestoreCollection<T, PT, D, PD>;

package/src/lib/common/firestore/collection/subcollection.single.d.ts

@@ -44,12 +44,14 @@ export interface SingleItemFirestoreCollection<T, PT, D extends FirestoreDocumen
  * a specific document. It combines the hierarchical relationship of parent-child documents
  * with the convenience of direct access to a single, known document in the subcollection.
  *
+ * @param config - Configuration for the single document subcollection.
+ * @returns A subcollection instance with specialized accessors for the single document.
+ *
  * @template T - The data type of the subcollection document
  * @template PT - The data type of the parent document
  * @template D - The document type for the subcollection document, defaults to FirestoreDocument<T>
  * @template PD - The document type for the parent document, defaults to FirestoreDocument<PT>
- * @param config - Configuration for the single document subcollection
- * @returns A subcollection instance with specialized accessors for the single document
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makeSingleItemFirestoreCollection<T, PT, D extends FirestoreDocument<T> = FirestoreDocument<T>, PD extends FirestoreDocument<PT> = FirestoreDocument<PT>>(config: SingleItemFirestoreCollectionConfig<T, PT, D, PD>): SingleItemFirestoreCollection<T, PT, D, PD>;

package/src/lib/common/firestore/context.d.ts

@@ -236,9 +236,11 @@ export type FirestoreContextFactory<F extends Firestore = Firestore> = (firestor
  * create FirestoreContext instances for specific Firestore instances. The resulting contexts
  * will use the provided drivers for all Firestore operations.
  *
+ * @param drivers - The Firestore drivers to use in created contexts.
+ * @returns A factory function that creates FirestoreContext instances.
+ *
  * @template F - The Firestore implementation type
- * @param drivers - The Firestore drivers to use in created contexts
- * @returns A factory function that creates FirestoreContext instances
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreContextFactory<F extends Firestore = Firestore>(drivers: FirestoreDrivers): FirestoreContextFactory<F>;

package/src/lib/common/firestore/driver/query.handler.d.ts

@@ -29,11 +29,12 @@ export interface MakeFirestoreQueryConstraintFunctionsDriver<B> extends Omit<Fir
  * handlers declaratively. The returned driver applies constraints sequentially using the
  * registered handlers and throws if an unsupported constraint type is encountered.
  *
+ * @param config - The handler map configuration.
+ * @returns A fully configured constraint functions driver.
+ * @throws {Error} When a query uses a constraint type not present in the handler map.
+ *
  * @template B - The platform-specific query builder type
- * @param config - The handler map configuration
- * @returns A fully configured constraint functions driver
  *
- * @throws {Error} When a query uses a constraint type not present in the handler map
  * @__NO_SIDE_EFFECTS__
  */
 export declare function makeFirestoreQueryConstraintFunctionsDriver<B>(config: MakeFirestoreQueryConstraintFunctionsDriver<B>): FirestoreQueryConstraintFunctionsDriver;

package/src/lib/common/firestore/error.d.ts

@@ -3,8 +3,8 @@ import { type UpdateData } from 'firebase/firestore';
  * Throws an error indicating the current Firestore driver does not support the called function.
  * Used by driver implementations to reject unsupported operations at runtime.
  *
- * @param message - Optional custom error message
- * @throws {Error} Always throws
+ * @param message - Optional custom error message.
+ * @throws {Error} Always throws.
  */
 export declare function unsupportedFirestoreDriverFunctionError(message?: string): void;
 /**
@@ -14,14 +14,15 @@ export declare function unsupportedFirestoreDriverFunctionError(message?: string
  * does not. This assertion normalizes behavior across both platforms so that empty updates
  * are caught early regardless of which driver is in use.
  *
- * @param data - The update data to validate
- * @throws {Error} When the data object has no keys
+ * @param data - The update data to validate.
+ * @throws {Error} When the data object has no keys.
  */
 export declare function assertFirestoreUpdateHasData(data: UpdateData<object>): void;
 /**
  * Creates and throws an error for empty update data passed to a {@link FirestoreDocumentDataAccessor}'s `update()` method.
  *
- * @throws {Error} Always throws
+ * @throws {Error} Always throws.
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function firestoreUpdateWithNoDataError(): void;