Interface ChainQuery<Document, PI, Ix>

interface ChainQuery<
    Document extends object,
    PI extends UnitIndex<Document>,
    Ix extends object,
> {
    "[iterator]"(): IterableIterator<Readonly<Document>>;
    delete(): number;
    filter(
        predicate: (item: Readonly<Document>) => boolean,
    ): ChainQuery<Document, PI, Ix>;
    forEach(action: (item: Document) => void): void;
    limit(count: number): ChainQuery<Document, PI, Ix>;
    map<B>(mapFn: (item: Readonly<Document>) => B): IterableIterator<B>;
    signal(): Computed<Readonly<Document>[]>;
    toArray(): Readonly<Document>[];
}

Type Parameters

Document extends object
PI extends UnitIndex<Document>
Ix extends object

Hierarchy

Query<Document, PI, Ix>
- ChainQuery

Methods

[iterator]

"[iterator]"(): IterableIterator<Readonly<Document>>
Returns IterableIterator<Readonly<Document>>
Overrides Query.[iterator]
- Defined in src/query.ts:295

delete

delete(): number
Delete all documents from the table matching this query.

Returns number
Inherited from Query.delete
- Defined in src/query.ts:139

filter

filter(
predicate: (item: Readonly<Document>) => boolean,
): ChainQuery<Document, PI, Ix>
Filter the query to only include documents matching the provided predicate function.
Parameters
- predicate: (item: Readonly<Document>) => boolean
Returns ChainQuery<Document, PI, Ix>
Inherited from Query.filter
- Defined in src/query.ts:149

forEach

forEach(action: (item: Document) => void): void
Call the provided action function for each document matched by the query in turn.
Parameters
- action: (item: Document) => void
Returns void
Inherited from Query.forEach
- Defined in src/query.ts:113

limit

limit(count: number): ChainQuery<Document, PI, Ix>
Limit the query to include at most count documents.
Parameters
- count: number
Returns ChainQuery<Document, PI, Ix>
Inherited from Query.limit
- Defined in src/query.ts:156

map

map<B>(mapFn: (item: Readonly<Document>) => B): IterableIterator<B>
Type Parameters
- B
Parameters
- mapFn: (item: Readonly<Document>) => B
Returns IterableIterator<B>
Inherited from Query.map
- Defined in src/query.ts:105

signal

signal(): Computed<Readonly<Document>[]>
Returns Computed<Readonly<Document>[]>
Inherited from Query.signal
- Defined in src/query.ts:126

toArray

toArray(): Readonly<Document>[]
Return the results of the query as an array of documents.

Returns Readonly<Document>[]
Inherited from Query.toArray
- Defined in src/query.ts:122