@bodil/bdb
    Preparing search index...

    Interface IndexQuery<Document, PI, I, Ix>

    interface IndexQuery<
        Document extends object,
        PI extends UnitIndex<Document>,
        I extends Index<Document>,
        Ix extends object,
    > {
        "[iterator]"(): IterableIterator<Readonly<Document>>;
        above(value: I["keyType"]): OpenRangeQuery<Document, PI, I, Ix>;
        andAbove(value: I["keyType"]): OpenRangeQuery<Document, PI, I, Ix>;
        andBelow(value: I["keyType"]): OpenRangeQuery<Document, PI, I, Ix>;
        below(value: I["keyType"]): OpenRangeQuery<Document, PI, I, Ix>;
        between(
            start: I["keyType"],
            end: I["keyType"],
        ): ClosedRangeQuery<Document, PI, I, Ix>;
        delete(): number;
        equals(value: I["keyType"]): EqualsQuery<Document, PI, Ix, I["keyType"]>;
        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>;
        max(): Option<I["keyType"]>;
        min(): Option<I["keyType"]>;
        signal(): Computed<Readonly<Document>[]>;
        toArray(): Readonly<Document>[];
    }

    Type Parameters

    Hierarchy

    Methods

    • Delete all documents from the table matching this query.

      Returns number

    • Call the provided action function for each document matched by the query in turn.

      Parameters

      Returns void

    Methods