Interface Cursor

Fakeable IndexedDB cursor contract.

interface Cursor {
    key: unknown;
    primaryKey: string;
    value: Record | undefined;
    done: boolean;
    continue(): Promise<boolean>;
    continueToKey(key: unknown): Promise<boolean>;
    advance(count: number): Promise<boolean>;
    delete(): Promise<void>;
    update(record: Record): Promise<void>;
    close(): void;
}

Index

Properties

key primaryKey value done

Methods

continue continueToKey advance delete update close

Properties

`Readonly`key

key: unknown

`Readonly`primaryKey

primaryKey: string

`Readonly`value

value: Record | undefined

`Readonly`done

done: boolean

Methods

continue

continue(): Promise<boolean>
Returns Promise<boolean>

continueToKey

continueToKey(key: unknown): Promise<boolean>
Parameters
- key: unknown
Returns Promise<boolean>

advance

advance(count: number): Promise<boolean>
Parameters
- count: number
Returns Promise<boolean>

delete

delete(): Promise<void>
Returns Promise<void>

update

update(record: Record): Promise<void>
Parameters
- record: Record
Returns Promise<void>

close

close(): void
Returns void