Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MultiChainBrowserIndexedDB

description

A class for managing browser IndexedDB database of Web3 Entities (used in sets)

Hierarchy

  • Dexie
    • MultiChainBrowserIndexedDB

Index

Constructors

Properties

Methods

Constructors

constructor

  • description

    Constructor for the MultiChainBrowserIndexedDatabase class that extends Dexie. Initializes the database with the name 'evm' and the following tables: accounts, contracts, eventFilters, logs, transactionRequests, transactions,

    Parameters

    • chainId: number

      The chainId of the database.

    Returns MultiChainBrowserIndexedDB

Properties

Collection

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

Type declaration

  • prototype: Collection<any, IndexableType>

Table

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

Type declaration

  • prototype: Table<any, IndexableType>

Transaction

Transaction: { prototype: Transaction }

Type declaration

  • prototype: Transaction

Version

Version: { prototype: Version }

Type declaration

  • prototype: Version

WhereClause

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

Type declaration

  • prototype: WhereClause<any, IndexableType>

Readonly _allTables

_allTables: {}

Type declaration

  • [name: string]: Table<any, IndexableType>

_dbSchema

_dbSchema: DbSchema

accounts

accounts: Table<Account, string>

contracts

contracts: Table<Contracts, string>

Readonly core

core: DBCore

eventFilters

eventFilters: Table<FilterByBlockHash, string>

logs

logs: Table<Log, string>

Readonly name

name: string

on

on: DbEvents

Readonly tables

tables: Table<any, IndexableType>[]

transactionRequests

transactionRequests: Table<TransactionRequest, string>

transactions

transactions: Table<TransactionAndReceipt, string>

Readonly verno

verno: number

Readonly vip

vip: Dexie

Static AbortError

AbortError: DexieErrorConstructor

Static BulkError

BulkError: BulkErrorConstructor

Static ConstraintError

ConstraintError: DexieErrorConstructor

Static DataCloneError

DataCloneError: DexieErrorConstructor

Static DataError

DataError: DexieErrorConstructor

Static DatabaseClosedError

DatabaseClosedError: DexieErrorConstructor

Static DexieError

DexieError: DexieErrorConstructor

Static ForeignAwaitError

ForeignAwaitError: DexieErrorConstructor

Static InternalError

InternalError: DexieErrorConstructor

Static InvalidAccessError

InvalidAccessError: DexieErrorConstructor

Static InvalidArgumentError

InvalidArgumentError: DexieErrorConstructor

Static InvalidStateError

InvalidStateError: DexieErrorConstructor

Static InvalidTableError

InvalidTableError: DexieErrorConstructor

Static MissingAPIError

MissingAPIError: DexieErrorConstructor

Static ModifyError

ModifyError: ModifyErrorConstructor

Static NoSuchDatabaseError

NoSuchDatabaseError: DexieErrorConstructor

Static NotFoundError

NotFoundError: DexieErrorConstructor

Static OpenFailedError

OpenFailedError: DexieErrorConstructor

Static PrematureCommitError

PrematureCommitError: DexieErrorConstructor

Static Promise

Promise: PromiseExtendedConstructor

Static QuotaExceededError

QuotaExceededError: DexieErrorConstructor

Static ReadOnlyError

ReadOnlyError: DexieErrorConstructor

Static SchemaError

SchemaError: DexieErrorConstructor

Static SubTransactionError

SubTransactionError: DexieErrorConstructor

Static TimeoutError

TimeoutError: DexieErrorConstructor

Static TransactionInactiveError

TransactionInactiveError: DexieErrorConstructor

Static UnknownError

UnknownError: DexieErrorConstructor

Static UnsupportedError

UnsupportedError: DexieErrorConstructor

Static UpgradeError

UpgradeError: DexieErrorConstructor

Static VersionChangeError

VersionChangeError: DexieErrorConstructor

Static VersionError

VersionError: DexieErrorConstructor

Static addons

addons: ((db: Dexie) => void)[]

Static currentTransaction

currentTransaction: Transaction

Static default

default: Dexie

Static dependencies

dependencies: DexieDOMDependencies

Static errnames

errnames: DexieErrors

Static maxKey

maxKey: string | void[][]

Static minKey

minKey: number

Static on

on: GlobalDexieEvents

Static semVer

semVer: string

Static version

version: number

Methods

_createTransaction

  • _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

  • backendDB(): IDBDatabase

  • Returns IDBDatabase

close

  • close(): void

  • Returns void

delete

  • delete(): PromiseExtended<void>

  • Returns PromiseExtended<void>

dynamicallyOpened

  • dynamicallyOpened(): boolean

  • Returns boolean

hasBeenClosed

  • hasBeenClosed(): boolean

  • Returns boolean

hasFailed

  • hasFailed(): boolean

  • Returns boolean

isOpen

  • isOpen(): boolean

  • Returns boolean

open

  • open(): PromiseExtended<Dexie>

  • Returns PromiseExtended<Dexie>

table

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

  • Type parameters

    • T = any

    • TKey = IndexableType

    Parameters

    • tableName: string

    Returns Table<T, TKey>

transaction

  • 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>

unuse

  • Parameters

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

    Returns MultiChainBrowserIndexedDB

  • Parameters

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

    Returns MultiChainBrowserIndexedDB

use

  • Parameters

    • middleware: Middleware<DBCore>

    Returns MultiChainBrowserIndexedDB

version

  • version(versionNumber: number): Version

  • Parameters

    • versionNumber: number

    Returns Version

Static Events

  • Events(ctx?: any): DexieEventSet

  • Parameters

    • Optional ctx: any

    Returns DexieEventSet

Static asap

  • asap(fn: Function): void

  • Parameters

    • fn: Function

    Returns void

Static deepClone

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

  • Type parameters

    • T

    Parameters

    • obj: T

    Returns T

Static delByKeyPath

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

  • Parameters

    • obj: Object
    • keyPath: string

    Returns void

Static delete

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

  • Parameters

    • dbName: string

    Returns Promise<void>

Static exists

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

  • Parameters

    • dbName: string

    Returns Promise<boolean>

Static extendObservabilitySet

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

  • Parameters

    • target: ObservabilitySet
    • newSet: ObservabilitySet

    Returns ObservabilitySet

Static getByKeyPath

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

  • Parameters

    • obj: Object
    • keyPath: string

    Returns any

Static getDatabaseNames

  • 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>

Static ignoreTransaction

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

  • Type parameters

    • U

    Parameters

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

        • Returns U

    Returns U

Static liveQuery

  • 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>

Static override

  • 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

Static setByKeyPath

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

  • Parameters

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

    Returns void

Static shallowClone

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

  • Type parameters

    • T

    Parameters

    • obj: T

    Returns T

Static vip

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

  • Type parameters

    • U

    Parameters

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

        • Returns U

    Returns U

Static waitFor

  • 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