@dereekb/firebase 13.11.13 → 13.11.15

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

@@ -130,29 +130,30 @@ export type IterationQueryDocChangeWatcherChangeType = 'addedAndRemoved' | 'adde
  * raw query snapshots and processed change events, making it easier to react to
  * specific types of changes.
  *
- * @template T - The document data type
  * @param config - Configuration for the watcher, including the iteration instance to watch
- *                and an optional delay before starting to monitor changes
- * @returns A watcher object with observables for streaming changes
+ *                and an optional delay before starting to monitor changes.
+ * @returns A watcher object with observables for streaming changes.
+ *
+ * @template T - The document data type
  *
  * @example
+ * ```ts
  * // Create a watcher for changes to active users
  * const usersIterator = firestoreItemPageIterator({
  *   queryFactory: () => collection(firestore, 'users').where('status', '==', 'active'),
  *   pageSize: 10
  * });
- *
  * const watcher = iterationQueryDocChangeWatcher({
  *   instance: usersIterator,
  *   delay: 1000 // wait 1 second after first results before watching for changes
  * });
- *
  * // React to specific change types
  * watcher.event$.subscribe(event => {
  *   if (event.type === 'added') {
  *     console.log('New users added:', event.added.map(change => change.doc.data()));
  *   }
  * });
+ * ```
  */
 export declare function iterationQueryDocChangeWatcher<T = unknown>(config: IterationQueryDocChangeWatcherConfig<T>): IterationQueryDocChangeWatcher<T>;
 /**
@@ -166,8 +167,9 @@ export declare function iterationQueryDocChangeWatcher<T = unknown>(config: Iter
  * 4. If only modifications are present, classify as 'modified'.
  * 5. If no changes are present, classify as 'none'.
  *
+ * @param group - The change group to classify.
+ * @returns The overall change type classification.
+ *
  * @template T - The document data type
- * @param group - The change group to classify
- * @returns The overall change type classification
  */
 export declare function iterationQueryDocChangeWatcherChangeTypeForGroup<T = unknown>(group: IterationQueryDocChangeWatcherChangeGroup<T>): IterationQueryDocChangeWatcherChangeType;

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

@@ -10,12 +10,14 @@ import { type FirestoreModelData, type SnapshotConverterConfig, type SnapshotCon
  * typed model objects and the data format stored in Firestore. It supports field-level conversions,
  * custom modifiers, and handles Firestore's merge options appropriately.
  *
+ * @param config - Field mappings and modifiers that drive the conversion.
+ * @returns Function set used to convert snapshots and writes for the model.
+ *
  * @template T - The application model type that will be used in your application code
  * @template O - The data type that will be stored in Firestore (defaults to FirestoreModelData<T>)
- * @param config - Configuration for the converter, including field mappings and modifiers
- * @returns A set of functions for converting between Firestore data and application models
  *
  * @example
+ * ```ts
  * // Create a converter for a User model
  * const userConverter = snapshotConverterFunctions<User, UserData>({
  *   fields: {
@@ -25,9 +27,10 @@ import { type FirestoreModelData, type SnapshotConverterConfig, type SnapshotCon
  *     }
  *   }
  * });
- *
  * // Use with a collection reference
  * const usersCollection = firestore.collection('users').withConverter(userConverter);
+ * ```
+ *
  * @__NO_SIDE_EFFECTS__
  */
 export declare function snapshotConverterFunctions<T extends object, O extends object = FirestoreModelData<T>>(config: SnapshotConverterConfig<T, O>): SnapshotConverterFunctions<T, O>;