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

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

import { CollectionReference } from './collection';
import { MetaType } from '../metaTypeCreator';
import { Firestore, Firestore_ } from '../alias';
import { GetOddOrEvenSegments } from '../utils';
import { IsValidDocIDLoop } from '../validID';
import { ErrorAutoIdTypeMustBeWideString, ErrorDocIdIncorrectType } from '../error';
/**
 * A {@link DocumentReference} refers to a document location in a Firestore database
 * and can be used to write, read, or listen to the location. The document at
 * the referenced location may or may not exist.
 */
export interface DocumentReference<T extends MetaType> {
    /** The type of this Firestore reference. */
    readonly type: 'document';
    /**
     * The {@link Firestore_} instance the document is in.
     * This is useful for performing transactions, for example.
     */
    readonly firestore: Firestore_;
    /**
     * The document's identifier within its collection.
     */
    get id(): T['docID'];
    /**
     * A string representing the path of the referenced document (relative
     * to the root of the database).
     */
    path: T['docPath'];
    /**
     * The collection this {@link DocumentReference} belongs to.
     */
    parent: CollectionReference<T>;
}
export type DocCreator = <T extends MetaType>(fStore: Firestore, ...collectionIDs: GetOddOrEvenSegments<T['collectionPath'], 'Odd'>) => Doc<T>;
export type Doc<T extends MetaType> = {
    /**
     * Gets a {@link DocumentReference} instance that refers to the document at the
     * specified absolute path.
     *
     *  related documentations:
     *  - {@link https://firelordjs.com/guides/metatype child meta type}
     *  - {@link https://firelordjs.com/quick_start#operations operation}
     * @param documentIds_or_CollectionReference
     * Type 1: all the docID(s) needed to build this document path, eg
     *  - for top-collection: example.doc(SelfDocId)
     *  - for sub-collection: example.doc(GrandParentDocId, ParentsDocId, SelfDocId).
     *
     * Type 2: CollectionReference (to create auto id doc ref), eg
     *  - for top-collection: example.doc(example.collection())
     *  - for sub-collection: example.doc(example.collection(GrandParentCollectionID, ParenCollectionID))
     *
     * @returns The {@link DocumentReference} instance.
     */
    <D extends IsValidDocIDLoop<GetOddOrEvenSegments<T['docPath'], 'Even'>> | CollectionReference<T>>(...documentIds_or_CollectionReference: D extends never ? D : D extends CollectionReference<T> ? string extends T['docID'] ? [D] : [ErrorAutoIdTypeMustBeWideString<T['docID']>] : D extends string[] ? IsValidDocIDLoop<D> : ErrorDocIdIncorrectType): DocumentReference<T>;
};
export type GetDocIds<T extends MetaType> = GetOddOrEvenSegments<T['docPath'], 'Even'>;