firelordjs/dist/types/refs/collectionGroup.d.ts

🔥 High Precision Typescript Wrapper for Firestore Web, Providing Unparalleled Type Safe and Dev Experience

import { MetaType } from '../metaTypeCreator';
import { Firestore } from '../alias';
import { Query } from './query';
/**
 * A {@link CollectionGroup} refers to all documents that are contained in a
 * collection or sub-collection with a specific collection ID.
 */
export interface CollectionGroup<T extends MetaType> extends Query<T> {
    /** The type of this Firestore reference. */
    readonly type: 'query';
}
export type CollectionGroupFunction<T extends MetaType> = {
    /**
     *  related documentations:
     *  - {@link https://firelordjs.com/quick_start/#query query}
     *  - {@link https://firelordjs.com/quick_start/#onsnapshot onSnapshot}
     * @returns — The created {@link CollectionGroup}.
     */
    (): CollectionGroup<T>;
};
export type CollectionGroupCreator = <T extends MetaType>(fStore: Firestore, collectionID: T['collectionID']) => CollectionGroupFunction<T>;