@magnetarjs/types/dist/Collection.d.ts

Magnetar shared types

import { DocFn } from './Magnetar.js';
import { FetchMetaDataCollection, MagnetarDeleteAction, MagnetarFetchAction, MagnetarFetchAverageAction, MagnetarFetchCountAction, MagnetarFetchSumAction, MagnetarInsertAction, MagnetarStreamAction } from './types/actions.js';
import { Query, WhereFilterOp, WhereFilterValue } from './types/clauses.js';
import { DeepPropType } from './types/utils/DeepPropType.js';
import { DefaultTo } from './types/utils/DefaultTo.js';
import { PartialDeep } from './types/utils/PartialDeep.js';
import { OPathsWithOptional } from './types/utils/Paths.js';
import { PickNumbers } from './types/utils/PickNumbers.js';
export type CollectionInstance<DocDataType extends {
    [key: string]: any;
} = {
    [key: string]: any;
}, GranularTypes extends {
    insert: {
        [key: string]: any;
    };
} = {
    insert: DocDataType;
}> = {
    /**
     * The cached data that was written or read so far
     */
    data: Map<string, DocDataType>;
    /**
     * Represents `data.size` of your collection, however, calling `fetchCount()` will update just this `count`, from where on it will no longer be linked to `data.size`.
     */
    count: number;
    /**
     * Holds the fetched "sum" of the fields on which you called `fetchSum()` so far. This only gets updated when `fetchSum` is called, it is not automatically updated when local cached `data` changes.
     */
    sum: PartialDeep<PickNumbers<DocDataType>>;
    /**
     * Holds the fetched "average" of the fields on which you called `fetchAverage()` so far. This only gets updated when `fetchAverage` is called, it is not automatically updated when local cached `data` changes.
     */
    average: PartialDeep<PickNumbers<DocDataType>>;
    /**
     * `doc` is available on every collection for chaining
     * @see {@link DocFn}
     * @example collection('pokedex').doc('001')
     */
    doc: DocFn<DocDataType>;
    /**
     * The id of the collection. When this is a nested collection, it will not include the full path, only the final part
     * @example 'items'
     */
    id: string;
    /**
     * The full path of the collection
     * @example 'pokedex/001/items'
     * @example 'pokedex'
     */
    path: string;
    /**
     * Returns the open stream promise of this collection, dependant on which `where`/`query`/`limit`/`orderBy` filters was used.
     *
     * Returns `null` when there is no open stream.
     *
     * This promise will resolve when `collection().closeStream()` is called, or when the stream closed because of an error.
     */
    streaming: () => Promise<void> | null;
    /**
     * Close the stream of this collection, dependant on which `where`/`query`/`limit`/`orderBy` filters was used.
     *
     * Does nothing if there is no open stream.
     */
    closeStream: () => void;
    /**
     * Close all streams of this collection, no matter which `where`/`query`/`limit`/`orderBy` filters were used.
     *
     * Does nothing if there are no open streams.
     */
    closeAllStreams: () => void;
    /**
     * @see {@link MagnetarFetchCountAction}
     */
    fetchCount: MagnetarFetchCountAction;
    /**
     * @see {@link MagnetarFetchSumAction}
     */
    fetchSum: MagnetarFetchSumAction<DocDataType>;
    /**
     * @see {@link MagnetarFetchAverageAction}
     */
    fetchAverage: MagnetarFetchAverageAction<DocDataType>;
    /**
     * @see {@link MagnetarFetchAction}
     */
    fetch: MagnetarFetchAction<DocDataType, 'collection'>;
    /**
     * @see {@link MagnetarStreamAction}
     */
    stream: MagnetarStreamAction<DocDataType>;
    /**
     * @see {@link MagnetarInsertAction}
     */
    insert: MagnetarInsertAction<GranularTypes['insert']>;
    /**
     * @see {@link MagnetarDeleteAction}
     */
    delete: MagnetarDeleteAction;
    /**
     * Chainable filter. Returns {@link CollectionInstance} with filter applied.
     */
    orderBy: (fieldPath: OPathsWithOptional<DocDataType>, direction?: 'asc' | 'desc') => CollectionInstance<DocDataType, GranularTypes>;
    /**
     * Chainable filter. Returns {@link CollectionInstance} with filter applied.
     */
    limit: (limitCount: number) => CollectionInstance<DocDataType, GranularTypes>;
    /**
     * Chainable filter. Returns {@link CollectionInstance} with filter applied.
     */
    where: <Path extends OPathsWithOptional<DocDataType>, WhereOp extends WhereFilterOp>(fieldPath: Path, operator: WhereOp, value: WhereFilterValue<WhereOp, DefaultTo<DeepPropType<DocDataType, Path>, any>>) => CollectionInstance<DocDataType, GranularTypes>;
    /**
     * Chainable filter. Returns {@link CollectionInstance} with filter applied.
     */
    query: (query: Query<DocDataType>) => CollectionInstance<DocDataType, GranularTypes>;
    /**
     * Chainable filter. Returns {@link CollectionInstance} with filter applied.
     */
    startAfter(docSnapshot: {
        [key: string]: any;
    }): CollectionInstance<DocDataType, GranularTypes>;
    startAfter(...fieldValues: unknown[]): CollectionInstance<DocDataType, GranularTypes>;
    /**
     * Meta data from the last fetch call
     */
    fetched: FetchMetaDataCollection;
};