Class StoredAvatarDatabase

Hierarchy

Dexie
- StoredAvatarDatabase

Index

Constructors

constructor

Constructors

constructor

new StoredAvatarDatabase(name): StoredAvatarDatabase
Parameters
- name: string
Returns StoredAvatarDatabase
Overrides Dexie.constructor
- Defined in packages/public-types/src/adaptors/localCustomAvatars/db.ts:16

Methods

backendDB

backendDB(): IDBDatabase
Returns IDBDatabase
Inherited from Dexie.backendDB
- Defined in node_modules/dexie/dist/dexie.d.ts:871

close

close(closeOptions?): void
Parameters
- OptionalcloseOptions: {
  disableAutoOpen: boolean;
  }
  - disableAutoOpen: boolean
Returns void
Inherited from Dexie.close
- Defined in node_modules/dexie/dist/dexie.d.ts:861

delete

delete(closeOptions?): PromiseExtended<void>
Parameters
- OptionalcloseOptions: {
 disableAutoOpen: boolean;
 }
 - disableAutoOpen: boolean
Returns PromiseExtended<void>
Inherited from Dexie.delete
- Defined in node_modules/dexie/dist/dexie.d.ts:864

deleteAvatar

deleteAvatar(id): Promise<void>
Parameters
- id: ReferenceData
Returns Promise<void>
- Defined in packages/public-types/src/adaptors/localCustomAvatars/db.ts:40

dynamicallyOpened

dynamicallyOpened(): boolean
Returns boolean
Inherited from Dexie.dynamicallyOpened
- Defined in node_modules/dexie/dist/dexie.d.ts:870

getStoredAvatarById

getStoredAvatarById(id): Promise<undefined | IStoredAvatar>
Parameters
- id: ReferenceData
Returns Promise<undefined | IStoredAvatar>
- Defined in packages/public-types/src/adaptors/localCustomAvatars/db.ts:32

hasBeenClosed

hasBeenClosed(): boolean
Returns boolean
Inherited from Dexie.hasBeenClosed
- Defined in node_modules/dexie/dist/dexie.d.ts:868

hasFailed

hasFailed(): boolean
Returns boolean
Inherited from Dexie.hasFailed
- Defined in node_modules/dexie/dist/dexie.d.ts:869

isOpen

isOpen(): boolean
Returns boolean
Inherited from Dexie.isOpen
- Defined in node_modules/dexie/dist/dexie.d.ts:867

open

open(): PromiseExtended<Dexie>
Returns PromiseExtended<Dexie>
Inherited from Dexie.open
- Defined in node_modules/dexie/dist/dexie.d.ts:853

storeAvatar

storeAvatar(avatar): Promise<string>
Parameters
- avatar: IStoredAvatar
Returns Promise<string>
- Defined in packages/public-types/src/adaptors/localCustomAvatars/db.ts:36

table

table<T, TKey, TInsertType>(tableName): Table<T, TKey, TInsertType>
Type Parameters
- T = any
- TKey = IndexableType
- TInsertType = T
Parameters
- tableName: string
Returns Table<T, TKey, TInsertType>
Inherited from Dexie.table
- Defined in node_modules/dexie/dist/dexie.d.ts:854

transaction

transaction(mode, tables, scope): PromiseExtended
Type Parameters
- U
Parameters
- mode: TransactionMode
- tables: readonly (string | Table<any, any, any>)[]
- scope: ((trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }) => U | PromiseLike)
 - - (trans): U | PromiseLike
 - Parameters
 trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }
 Returns U | PromiseLike
Returns PromiseExtended
Inherited from Dexie.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:855
transaction(mode, table, scope): PromiseExtended
Type Parameters
- U
Parameters
- mode: TransactionMode
- table: string | Table<any, any, any>
- scope: ((trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }) => U | PromiseLike)
 - - (trans): U | PromiseLike
 - Parameters
 trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }
 Returns U | PromiseLike
Returns PromiseExtended
Inherited from Dexie.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:856
transaction(mode, table, table2, scope): PromiseExtended
Type Parameters
- U
Parameters
- mode: TransactionMode
- table: string | Table<any, any, any>
- table2: string | Table<any, any, any>
- scope: ((trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }) => U | PromiseLike)
 - - (trans): U | PromiseLike
 - Parameters
 trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }
 Returns U | PromiseLike
Returns PromiseExtended
Inherited from Dexie.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:857
transaction(mode, table, table2, table3, scope): PromiseExtended
Type Parameters
- U
Parameters
- mode: TransactionMode
- table: string | Table<any, any, any>
- table2: string | Table<any, any, any>
- table3: string | Table<any, any, any>
- scope: ((trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }) => U | PromiseLike)
 - - (trans): U | PromiseLike
 - Parameters
 trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }
 Returns U | PromiseLike
Returns PromiseExtended
Inherited from Dexie.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:858
transaction(mode, table, table2, table3, table4, scope): PromiseExtended
Type Parameters
- U
Parameters
- mode: TransactionMode
- table: string | Table<any, any, any>
- table2: string | Table<any, any, any>
- table3: string | Table<any, any, any>
- table4: string | Table<any, any, any>
- scope: ((trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }) => U | PromiseLike)
 - - (trans): U | PromiseLike
 - Parameters
 trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }
 Returns U | PromiseLike
Returns PromiseExtended
Inherited from Dexie.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:859
transaction(mode, table, table2, table3, table5, scope): PromiseExtended
Type Parameters
- U
Parameters
- mode: TransactionMode
- table: string | Table<any, any, any>
- table2: string | Table<any, any, any>
- table3: string | Table<any, any, any>
- table5: string | Table<any, any, any>
- scope: ((trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }) => U | PromiseLike)
 - - (trans): U | PromiseLike
 - Parameters
 trans: Transaction & {
 storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>;
 }
 Returns U | PromiseLike
Returns PromiseExtended
Inherited from Dexie.transaction
- Defined in node_modules/dexie/dist/dexie.d.ts:860

unuse

unuse(__namedParameters): this
Parameters
- __namedParameters: Middleware<{
 stack: "dbcore";
 }>
Returns this
Inherited from Dexie.unuse
- Defined in node_modules/dexie/dist/dexie.d.ts:874
unuse(__namedParameters): this
Parameters
- __namedParameters: {
  name: string;
  stack: "dbcore";
  }
  - name: string
  - stack: "dbcore"
Returns this
Inherited from Dexie.unuse
- Defined in node_modules/dexie/dist/dexie.d.ts:877

use

use(middleware): this
Parameters
- middleware: Middleware<DBCore>
Returns this
Inherited from Dexie.use
- Defined in node_modules/dexie/dist/dexie.d.ts:872

version

version(versionNumber): Version
Parameters
- versionNumber: number
Returns Version
Inherited from Dexie.version
- Defined in node_modules/dexie/dist/dexie.d.ts:850

`Static`asap

asap(fn): void
Parameters
- fn: Function
Returns void
Inherited from Dexie.asap
- Defined in node_modules/dexie/dist/dexie.d.ts:1142

`Static`deepClone

deepClone<T>(obj): T
Type Parameters
- T
Parameters
- obj: T
Returns T
Inherited from Dexie.deepClone
- Defined in node_modules/dexie/dist/dexie.d.ts:1141

`Static`delByKeyPath

delByKeyPath(obj, keyPath): void
Parameters
- obj: Object
- keyPath: string | string[]
Returns void
Inherited from Dexie.delByKeyPath
- Defined in node_modules/dexie/dist/dexie.d.ts:1139

`Static`delete

delete(dbName): Promise<void>
Parameters
- dbName: string
Returns Promise<void>
Inherited from Dexie.delete
- Defined in node_modules/dexie/dist/dexie.d.ts:1146

`Static`exists

exists(dbName): Promise<boolean>
Parameters
- dbName: string
Returns Promise<boolean>
Inherited from Dexie.exists
- Defined in node_modules/dexie/dist/dexie.d.ts:1145

`Static`extendObservabilitySet

extendObservabilitySet(target, newSet): ObservabilitySet
Parameters
- target: ObservabilitySet
- newSet: ObservabilitySet
Returns ObservabilitySet
Inherited from Dexie.extendObservabilitySet
- Defined in node_modules/dexie/dist/dexie.d.ts:1135

`Static`getByKeyPath

getByKeyPath(obj, keyPath): any
Parameters
- obj: Object
- keyPath: string | string[]
Returns any
Inherited from Dexie.getByKeyPath
- Defined in node_modules/dexie/dist/dexie.d.ts:1137

`Static`getDatabaseNames

getDatabaseNames(): Promise<string[]>
Returns Promise<string[]>
Inherited from Dexie.getDatabaseNames
- Defined in node_modules/dexie/dist/dexie.d.ts:1129
getDatabaseNames<R>(thenShortcut): Promise<R>
Type Parameters
- R
Parameters
- thenShortcut: ThenShortcut<string[], R>
Returns Promise<R>
Inherited from Dexie.getDatabaseNames
- Defined in node_modules/dexie/dist/dexie.d.ts:1130

`Static`ignoreTransaction

ignoreTransaction(fn): U
Type Parameters
- U
Parameters
- fn: (() => U)
  - - (): U
    - Returns U
Returns U
Inherited from Dexie.ignoreTransaction
- Defined in node_modules/dexie/dist/dexie.d.ts:1132

`Static`liveQuery

liveQuery<T>(fn): Observable<T>
Type Parameters
- T
Parameters
- fn: (() => T | Promise<T>)
 - - (): T | Promise<T>
 - Returns T | Promise<T>
Returns Observable<T>
Inherited from Dexie.liveQuery
- Defined in node_modules/dexie/dist/dexie.d.ts:1134

`Static`override

override<F>(origFunc, overridedFactory): F
Type Parameters
- F
Parameters
- origFunc: F
- overridedFactory: ((fn: any) => any)
  - - (fn): any
    - Parameters
      fn: any
      Returns any
Returns F
Inherited from Dexie.override
- Defined in node_modules/dexie/dist/dexie.d.ts:1136

`Static`setByKeyPath

setByKeyPath(obj, keyPath, value): void
Parameters
- obj: Object
- keyPath: string | string[]
- value: any
Returns void
Inherited from Dexie.setByKeyPath
- Defined in node_modules/dexie/dist/dexie.d.ts:1138

`Static`shallowClone

shallowClone<T>(obj): T
Type Parameters
- T
Parameters
- obj: T
Returns T
Inherited from Dexie.shallowClone
- Defined in node_modules/dexie/dist/dexie.d.ts:1140

`Static`vip

vip(scopeFunction): U
Type Parameters
- U
Parameters
- scopeFunction: (() => U)
  - - (): U
    - Returns U
Returns U
Inherited from Dexie.vip
- Defined in node_modules/dexie/dist/dexie.d.ts:1131

`Static`waitFor

waitFor<T>(promise, timeoutMilliseconds?): Promise<T>
Type Parameters
- T
Parameters
- promise: T | PromiseLike<T>
- OptionaltimeoutMilliseconds: number
Returns Promise<T>
Inherited from Dexie.waitFor
- Defined in node_modules/dexie/dist/dexie.d.ts:1128

Properties

`Readonly`_allTables

_allTables: {
[name: string]: Table<any, IndexableType>;
}

_createTransaction

_createTransaction: ((this: Dexie, mode: IDBTransactionMode, storeNames: ArrayLike<string>, dbschema: DbSchema, parentTransaction?: null | Transaction) => Transaction)

_dbSchema

_dbSchema: DbSchema

`Readonly`_novip

_novip: Dexie

`Readonly`_options

_options: DexieOptions

Collection

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

`Readonly`core

core: DBCore

`Readonly`name

name: string

on

on: DbEvents

once

once: DbEventFns

storedAvatars

storedAvatars: Table<IStoredAvatar, string, IStoredAvatar>

Table

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

`Readonly`tables

tables: Table<any, any, any>[]

Transaction

Transaction: {
prototype: Transaction;
}

`Readonly`verno

verno: number

Version

Version: Function & {
prototype: ExtendableVersion;
}

`Readonly`vip

vip: Dexie

WhereClause

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

`Static`AbortError

AbortError: DexieErrorConstructor

`Static`addons

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

`Static`BulkError

BulkError: BulkErrorConstructor

`Static`cache

cache: GlobalQueryCache

`Static`ConstraintError

ConstraintError: DexieErrorConstructor

`Static`currentTransaction

currentTransaction: Transaction

`Static`DatabaseClosedError

DatabaseClosedError: DexieErrorConstructor

`Static`DataCloneError

DataCloneError: DexieErrorConstructor

`Static`DataError

DataError: DexieErrorConstructor

`Static`debug

debug: boolean | "dexie"

`Static`default

default: Dexie

`Static`dependencies

dependencies: DexieDOMDependencies

`Static`DexieError

DexieError: DexieErrorConstructor

`Static` `Optional`disableBfCache

disableBfCache?: boolean

`Static`errnames

errnames: DexieErrors

`Static`Events

Events: ((ctx?: any) => DexieEventSet)

`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`maxKey

maxKey: string | void[][]

`Static`minKey

minKey: number

`Static`MissingAPIError

MissingAPIError: DexieErrorConstructor

`Static`ModifyError

ModifyError: ModifyErrorConstructor

`Static`NoSuchDatabaseError

NoSuchDatabaseError: DexieErrorConstructor

`Static`NotFoundError

NotFoundError: DexieErrorConstructor

`Static`on

on: GlobalDexieEvents

`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`semVer

semVer: string

`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`version

version: number

`Static`VersionChangeError

VersionChangeError: DexieErrorConstructor

`Static`VersionError

VersionError: DexieErrorConstructor

Class StoredAvatarDatabase

Hierarchy

Index

Constructors

Methods

Properties

Constructors

constructor

Parameters

Returns StoredAvatarDatabase

Methods

backendDB

Returns IDBDatabase

close

Parameters

disableAutoOpen: boolean

Returns void

delete

Parameters

disableAutoOpen: boolean

Returns PromiseExtended<void>

deleteAvatar

Parameters

Returns Promise<void>

dynamicallyOpened

Returns boolean

getStoredAvatarById

Parameters

Returns Promise<undefined | IStoredAvatar>

hasBeenClosed

Returns boolean

hasFailed

Returns boolean

isOpen

Returns boolean

open

Returns PromiseExtended<Dexie>

storeAvatar

Parameters

Returns Promise<string>

table

Type Parameters

Parameters

Returns Table<T, TKey, TInsertType>

transaction

Type Parameters

Parameters

Parameters

Returns U | PromiseLike<U>

Returns PromiseExtended<U>

Type Parameters

Parameters

Parameters

Returns U | PromiseLike<U>

Returns PromiseExtended<U>

Type Parameters

Parameters

Parameters

Returns U | PromiseLike<U>

Returns PromiseExtended<U>

Type Parameters

Parameters

Parameters

Returns U | PromiseLike<U>

Returns PromiseExtended<U>

Type Parameters

Parameters

Parameters

Returns U | PromiseLike<U>

Returns PromiseExtended<U>

Type Parameters

Parameters

Parameters

Returns U | PromiseLike<U>

Returns PromiseExtended<U>

unuse

Parameters

Returns this

Parameters

name: string

`Static`asap

`Static`deepClone

`Static`delByKeyPath

`Static`delete

`Static`exists

`Static`extendObservabilitySet

`Static`getByKeyPath

`Static`getDatabaseNames

`Static`ignoreTransaction

`Static`liveQuery

`Static`override

`Static`setByKeyPath

`Static`shallowClone

`Static`vip

`Static`waitFor

`Readonly`_allTables