Polkadot Apps
    Preparing search index...

    Interface Table<T, Key, TInsertType>

    interface Table<T = any, Key = any, TInsertType = T> {
        core: DBCoreTable;
        db: Dexie;
        hook: TableHooks<T, Key, TInsertType>;
        name: string;
        schema: TableSchema;
        add(item: TInsertType, key?: Key): PromiseExtended<Key>;
        bulkAdd<B extends boolean>(
            items: readonly TInsertType[],
            keys: IndexableTypeArrayReadonly,
            options: { allKeys: B },
        ): PromiseExtended<B extends true ? Key[] : Key>;
        bulkAdd<B extends boolean>(
            items: readonly TInsertType[],
            options: { allKeys: B },
        ): PromiseExtended<B extends true ? Key[] : Key>;
        bulkAdd(
            items: readonly TInsertType[],
            keys?: IndexableTypeArrayReadonly,
            options?: { allKeys: boolean },
        ): PromiseExtended<Key>;
        bulkDelete(keys: Key[]): PromiseExtended<void>;
        bulkGet(keys: Key[]): PromiseExtended<(T | undefined)[]>;
        bulkPut<B extends boolean>(
            items: readonly TInsertType[],
            keys: IndexableTypeArrayReadonly,
            options: { allKeys: B },
        ): PromiseExtended<B extends true ? Key[] : Key>;
        bulkPut<B extends boolean>(
            items: readonly TInsertType[],
            options: { allKeys: B },
        ): PromiseExtended<B extends true ? Key[] : Key>;
        bulkPut(
            items: readonly TInsertType[],
            keys?: IndexableTypeArrayReadonly,
            options?: { allKeys: boolean },
        ): PromiseExtended<Key>;
        bulkUpdate(
            keysAndChanges: readonly { changes: UpdateSpec<T>; key: Key }[],
        ): PromiseExtended<number>;
        clear(): PromiseExtended<void>;
        count(): PromiseExtended<number>;
        count<R>(thenShortcut: ThenShortcut<number, R>): PromiseExtended<R>;
        delete(key: Key): PromiseExtended<void>;
        each(
            callback: (obj: T, cursor: { key: any; primaryKey: Key }) => any,
        ): PromiseExtended<void>;
        filter(fn: (obj: T) => boolean): Collection<T, Key, TInsertType>;
        get(key: Key): PromiseExtended<T | undefined>;
        get<R>(
            key: Key,
            thenShortcut: ThenShortcut<T | undefined, R>,
        ): PromiseExtended<R>;
        get(
            equalityCriterias: { [key: string]: any },
        ): PromiseExtended<T | undefined>;
        get<R>(
            equalityCriterias: { [key: string]: any },
            thenShortcut: ThenShortcut<T | undefined, R>,
        ): PromiseExtended<R>;
        limit(n: number): Collection<T, Key, TInsertType>;
        mapToClass(constructor: Function): Function;
        offset(n: number): Collection<T, Key, TInsertType>;
        orderBy(index: string | string[]): Collection<T, Key, TInsertType>;
        put(item: TInsertType, key?: Key): PromiseExtended<Key>;
        reverse(): Collection<T, Key, TInsertType>;
        toArray(): PromiseExtended<T[]>;
        toArray<R>(thenShortcut: ThenShortcut<T[], R>): PromiseExtended<R>;
        toCollection(): Collection<T, Key, TInsertType>;
        update(
            key: T | Key,
            changes:
                | UpdateSpec<TInsertType>
                | (
                    (
                        obj: T,
                        ctx: { primKey: IndexableType; value: any },
                    ) => boolean | void
                ),
        ): PromiseExtended<number>;
        upsert(
            key: T | Key,
            changes: UpdateSpec<TInsertType>,
        ): PromiseExtended<boolean>;
        where(index: string | string[]): WhereClause<T, Key, TInsertType>;
        where(
            equalityCriterias: { [key: string]: any },
        ): Collection<T, Key, TInsertType>;
    }

    Type Parameters

    • T = any
    • Key = any
    • TInsertType = T

    Hierarchy

    Index

    Properties

    core db hook name schema

    Methods

    add bulkAdd bulkDelete bulkGet bulkPut bulkUpdate clear count delete each filter get limit mapToClass offset orderBy put reverse toArray toCollection update upsert where

    Properties

    core: DBCoreTable
    db: Dexie
    hook: TableHooks<T, Key, TInsertType>
    name: string
    schema: TableSchema

    Methods

    • Parameters

      Returns PromiseExtended<Key>

    • Type Parameters

      • B extends boolean

      Parameters

      • items: readonly TInsertType[]
      • keys: IndexableTypeArrayReadonly
      • options: { allKeys: B }

      Returns PromiseExtended<B extends true ? Key[] : Key>

    • Type Parameters

      • B extends boolean

      Parameters

      Returns PromiseExtended<B extends true ? Key[] : Key>

    • Parameters

      • items: readonly TInsertType[]
      • Optionalkeys: IndexableTypeArrayReadonly
      • Optionaloptions: { allKeys: boolean }

      Returns PromiseExtended<Key>

    • Parameters

      Returns PromiseExtended<void>

    • Parameters

      Returns PromiseExtended<(T | undefined)[]>

    • Type Parameters

      • B extends boolean

      Parameters

      • items: readonly TInsertType[]
      • keys: IndexableTypeArrayReadonly
      • options: { allKeys: B }

      Returns PromiseExtended<B extends true ? Key[] : Key>

    • Type Parameters

      • B extends boolean

      Parameters

      Returns PromiseExtended<B extends true ? Key[] : Key>

    • Parameters

      • items: readonly TInsertType[]
      • Optionalkeys: IndexableTypeArrayReadonly
      • Optionaloptions: { allKeys: boolean }

      Returns PromiseExtended<Key>

    • Parameters

      • keysAndChanges: readonly { changes: UpdateSpec<T>; key: Key }[]

      Returns PromiseExtended<number>

    • Returns PromiseExtended<void>

    • Returns PromiseExtended<number>

    • Type Parameters

      • R

      Parameters

      • thenShortcut: ThenShortcut<number, R>

      Returns PromiseExtended<R>

    • Parameters

      Returns PromiseExtended<void>

    • Parameters

      • callback: (obj: T, cursor: { key: any; primaryKey: Key }) => any

      Returns PromiseExtended<void>

    • Parameters

      • fn: (obj: T) => boolean

      Returns Collection<T, Key, TInsertType>

    • Parameters

      Returns PromiseExtended<T | undefined>

    • Type Parameters

      • R

      Parameters

      • key: Key
      • thenShortcut: ThenShortcut<T | undefined, R>

      Returns PromiseExtended<R>

    • Parameters

      • equalityCriterias: { [key: string]: any }

      Returns PromiseExtended<T | undefined>

    • Type Parameters

      • R

      Parameters

      • equalityCriterias: { [key: string]: any }
      • thenShortcut: ThenShortcut<T | undefined, R>

      Returns PromiseExtended<R>

    • Parameters

      • n: number

      Returns Collection<T, Key, TInsertType>

    • Parameters

      • constructor: Function

      Returns Function

    • Parameters

      • n: number

      Returns Collection<T, Key, TInsertType>

    • Parameters

      • index: string | string[]

      Returns Collection<T, Key, TInsertType>

    • Parameters

      Returns PromiseExtended<Key>

    • Returns Collection<T, Key, TInsertType>

    • Returns PromiseExtended<T[]>

    • Type Parameters

      • R

      Parameters

      • thenShortcut: ThenShortcut<T[], R>

      Returns PromiseExtended<R>

    • Returns Collection<T, Key, TInsertType>

    • Parameters

      • key: T | Key
      • changes:
            | UpdateSpec<TInsertType>
            | ((obj: T, ctx: { primKey: IndexableType; value: any }) => boolean | void)

      Returns PromiseExtended<number>

    • Parameters

      Returns PromiseExtended<boolean>

    • Parameters

      • index: string | string[]

      Returns WhereClause<T, Key, TInsertType>

    • Parameters

      • equalityCriterias: { [key: string]: any }

      Returns Collection<T, Key, TInsertType>

    Settings

    Member Visibility

    On This Page

    Properties
    Methods