Options
All
  • Public
  • Public/Protected
  • All
Menu
description

A class for managing browser IndexedDB database of Web3 Entities cross-chain metadata.

Hierarchy

  • Dexie
    • MultiChainBrowserIndexedDBMeta

Index

Constructors

Properties

Collection: { prototype: Collection<any, IndexableType> }

Type declaration

  • prototype: Collection<any, IndexableType>
Table: { prototype: Table<any, IndexableType> }

Type declaration

  • prototype: Table<any, IndexableType>
Transaction: { prototype: Transaction }

Type declaration

  • prototype: Transaction
Version: { prototype: Version }

Type declaration

  • prototype: Version
WhereClause: { prototype: WhereClause<any, IndexableType> }

Type declaration

  • prototype: WhereClause<any, IndexableType>
_allTables: {}

Type declaration

  • [name: string]: Table<any, IndexableType>
_dbSchema: DbSchema
accounts: Table<AccountMeta, string>
core: DBCore
name: string
on: DbEvents
tables: Table<any, IndexableType>[]
verno: number
vip: Dexie
AbortError: DexieErrorConstructor
BulkError: BulkErrorConstructor
ConstraintError: DexieErrorConstructor
DataCloneError: DexieErrorConstructor
DataError: DexieErrorConstructor
DatabaseClosedError: DexieErrorConstructor
DexieError: DexieErrorConstructor
ForeignAwaitError: DexieErrorConstructor
InternalError: DexieErrorConstructor
InvalidAccessError: DexieErrorConstructor
InvalidArgumentError: DexieErrorConstructor
InvalidStateError: DexieErrorConstructor
InvalidTableError: DexieErrorConstructor
MissingAPIError: DexieErrorConstructor
ModifyError: ModifyErrorConstructor
NoSuchDatabaseError: DexieErrorConstructor
NotFoundError: DexieErrorConstructor
OpenFailedError: DexieErrorConstructor
PrematureCommitError: DexieErrorConstructor
Promise: PromiseExtendedConstructor
QuotaExceededError: DexieErrorConstructor
ReadOnlyError: DexieErrorConstructor
SchemaError: DexieErrorConstructor
SubTransactionError: DexieErrorConstructor
TimeoutError: DexieErrorConstructor
TransactionInactiveError: DexieErrorConstructor
UnknownError: DexieErrorConstructor
UnsupportedError: DexieErrorConstructor
UpgradeError: DexieErrorConstructor
VersionChangeError: DexieErrorConstructor
VersionError: DexieErrorConstructor
addons: ((db: Dexie) => void)[]
currentTransaction: Transaction
default: Dexie
dependencies: DexieDOMDependencies
errnames: DexieErrors
maxKey: string | void[][]
minKey: number
on: GlobalDexieEvents
semVer: string
version: number

Methods

  • _createTransaction(mode: IDBTransactionMode, storeNames: ArrayLike<string>, dbschema: DbSchema, parentTransaction?: null | Transaction): Transaction
  • Parameters

    • mode: IDBTransactionMode
    • storeNames: ArrayLike<string>
    • dbschema: DbSchema
    • Optional parentTransaction: null | Transaction

    Returns Transaction

  • backendDB(): IDBDatabase
  • Returns IDBDatabase

  • close(): void
  • Returns void

  • delete(): PromiseExtended<void>
  • Returns PromiseExtended<void>

  • dynamicallyOpened(): boolean
  • Returns boolean

  • hasBeenClosed(): boolean
  • Returns boolean

  • hasFailed(): boolean
  • Returns boolean

  • isOpen(): boolean
  • Returns boolean

  • open(): PromiseExtended<Dexie>
  • Returns PromiseExtended<Dexie>

  • table<T, TKey>(tableName: string): Table<T, TKey>
  • Type parameters

    • T = any

    • TKey = IndexableType

    Parameters

    • tableName: string

    Returns Table<T, TKey>

  • transaction<U>(mode: TransactionMode, table: Table<any, IndexableType>, scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, table: string, scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, table: Table<any, IndexableType>, table2: Table<any, IndexableType>, scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, table: string, table2: string, scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, table: Table<any, IndexableType>, table2: Table<any, IndexableType>, table3: Table<any, IndexableType>, scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, table: string, table2: string, table3: string, scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, table: Table<any, IndexableType>, table2: Table<any, IndexableType>, table3: Table<any, IndexableType>, table4: Table<any, IndexableType>, scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, table: string, table2: string, table3: string, table4: string, scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, table: Table<any, IndexableType>, table2: Table<any, IndexableType>, table3: Table<any, IndexableType>, table4: Table<any, IndexableType>, table5: Table<any, IndexableType>, scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, table: string, table2: string, table3: string, table4: string, table5: string, scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, tables: Table<any, IndexableType>[], scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • transaction<U>(mode: TransactionMode, tables: string[], scope: (trans: Transaction) => U | PromiseLike<U>): PromiseExtended<U>
  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • table: Table<any, IndexableType>
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • table: string
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • table: Table<any, IndexableType>
    • table2: Table<any, IndexableType>
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • table: string
    • table2: string
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • table: Table<any, IndexableType>
    • table2: Table<any, IndexableType>
    • table3: Table<any, IndexableType>
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • table: string
    • table2: string
    • table3: string
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • table: Table<any, IndexableType>
    • table2: Table<any, IndexableType>
    • table3: Table<any, IndexableType>
    • table4: Table<any, IndexableType>
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • table: string
    • table2: string
    • table3: string
    • table4: string
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • table: Table<any, IndexableType>
    • table2: Table<any, IndexableType>
    • table3: Table<any, IndexableType>
    • table4: Table<any, IndexableType>
    • table5: Table<any, IndexableType>
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • table: string
    • table2: string
    • table3: string
    • table4: string
    • table5: string
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • tables: Table<any, IndexableType>[]
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Type parameters

    • U

    Parameters

    • mode: TransactionMode
    • tables: string[]
    • scope: (trans: Transaction) => U | PromiseLike<U>
        • (trans: Transaction): U | PromiseLike<U>
        • Parameters

          • trans: Transaction

          Returns U | PromiseLike<U>

    Returns PromiseExtended<U>

  • Parameters

    • __namedParameters: Middleware<{ stack: "dbcore" }>

    Returns MultiChainBrowserIndexedDBMeta

  • Parameters

    • __namedParameters: { name: string; stack: "dbcore" }
      • name: string
      • stack: "dbcore"

    Returns MultiChainBrowserIndexedDBMeta

  • Parameters

    • middleware: Middleware<DBCore>

    Returns MultiChainBrowserIndexedDBMeta

  • version(versionNumber: number): Version
  • Parameters

    • versionNumber: number

    Returns Version

  • Events(ctx?: any): DexieEventSet
  • Parameters

    • Optional ctx: any

    Returns DexieEventSet

  • asap(fn: Function): void
  • Parameters

    • fn: Function

    Returns void

  • deepClone<T>(obj: T): T
  • Type parameters

    • T

    Parameters

    • obj: T

    Returns T

  • delByKeyPath(obj: Object, keyPath: string): void
  • Parameters

    • obj: Object
    • keyPath: string

    Returns void

  • delete(dbName: string): Promise<void>
  • Parameters

    • dbName: string

    Returns Promise<void>

  • exists(dbName: string): Promise<boolean>
  • Parameters

    • dbName: string

    Returns Promise<boolean>

  • extendObservabilitySet(target: ObservabilitySet, newSet: ObservabilitySet): ObservabilitySet
  • Parameters

    • target: ObservabilitySet
    • newSet: ObservabilitySet

    Returns ObservabilitySet

  • getByKeyPath(obj: Object, keyPath: string): any
  • Parameters

    • obj: Object
    • keyPath: string

    Returns any

  • getDatabaseNames(): Promise<string[]>
  • getDatabaseNames<R>(thenShortcut: ThenShortcut<string[], R>): Promise<R>
  • Returns Promise<string[]>

  • Type parameters

    • R

    Parameters

    • thenShortcut: ThenShortcut<string[], R>

    Returns Promise<R>

  • ignoreTransaction<U>(fn: () => U): U
  • Type parameters

    • U

    Parameters

    • fn: () => U
        • (): U
        • Returns U

    Returns U

  • liveQuery<T>(fn: () => T | Promise<T>): Observable<T>
  • Type parameters

    • T

    Parameters

    • fn: () => T | Promise<T>
        • (): T | Promise<T>
        • Returns T | Promise<T>

    Returns Observable<T>

  • override<F>(origFunc: F, overridedFactory: (fn: any) => any): F
  • Type parameters

    • F

    Parameters

    • origFunc: F
    • overridedFactory: (fn: any) => any
        • (fn: any): any
        • Parameters

          • fn: any

          Returns any

    Returns F

  • setByKeyPath(obj: Object, keyPath: string, value: any): void
  • Parameters

    • obj: Object
    • keyPath: string
    • value: any

    Returns void

  • shallowClone<T>(obj: T): T
  • Type parameters

    • T

    Parameters

    • obj: T

    Returns T

  • vip<U>(scopeFunction: () => U): U
  • Type parameters

    • U

    Parameters

    • scopeFunction: () => U
        • (): U
        • Returns U

    Returns U

  • waitFor<T>(promise: T | PromiseLike<T>, timeoutMilliseconds?: number): Promise<T>
  • Type parameters

    • T

    Parameters

    • promise: T | PromiseLike<T>
    • Optional timeoutMilliseconds: number

    Returns Promise<T>

Generated using TypeDoc