Class default<SCHEMA>

Type Parameters

SCHEMA

Hierarchy

Host<default.IEvents>
- default

Index

Constructors

constructor

new default<SCHEMA>(schema: Schema<SCHEMA>): default<SCHEMA>
Type Parameters
- SCHEMA
Parameters
- schema: Schema<SCHEMA>
Returns default<SCHEMA>
Overrides EventEmitter.Host<Database.IEvents>.constructor
- Defined in src/game/ui/util/Database.ts:41

Properties

`Readonly` event

event: IEventEmitter<default<SCHEMA>, default.IEvents>

Methods

all

all<KEY>(store: KEY, range?: IDBKeyRange): Promise<SCHEMA[KEY][]>
Type Parameters
- KEY extends string | number | symbol
Parameters
- store: KEY
- Optional range: IDBKeyRange
Returns Promise<SCHEMA[KEY][]>
- Defined in src/game/ui/util/Database.ts:49
all<KEY>(store: KEY, key: string | IDBKeyRange, index: string): Promise<SCHEMA[KEY][]>
Type Parameters
- KEY extends string | number | symbol
Parameters
- store: KEY
- key: string | IDBKeyRange
- index: string
Returns Promise<SCHEMA[KEY][]>
- Defined in src/game/ui/util/Database.ts:50

clear

clear(store: keyof SCHEMA): Promise<void>
Parameters
- store: keyof SCHEMA
Returns Promise<void>
- Defined in src/game/ui/util/Database.ts:71

count

count(store: keyof SCHEMA): Promise<number>
Parameters
- store: keyof SCHEMA
Returns Promise<number>
- Defined in src/game/ui/util/Database.ts:67

createStore

createStore(store: keyof SCHEMA, options?: IDBObjectStoreParameters, init?: ((store: IDBObjectStore) => any)): Promise<void>
Parameters
- store: keyof SCHEMA
- Optional options: IDBObjectStoreParameters
- Optional init: ((store: IDBObjectStore) => any)
  - - (store: IDBObjectStore): any
    - Parameters
      
      store: IDBObjectStore
      
      Returns any
Returns Promise<void>
- Defined in src/game/ui/util/Database.ts:110

delete

delete(store: keyof SCHEMA, key: string): Promise<void>
Parameters
- store: keyof SCHEMA
- key: string
Returns Promise<void>
- Defined in src/game/ui/util/Database.ts:59

dispose

dispose(): Promise<void>
Returns Promise<void>
- Defined in src/game/ui/util/Database.ts:120

get

get<KEY>(store: KEY, key: string, index?: string): Promise<undefined | SCHEMA[KEY]>
Type Parameters
- KEY extends string | number | symbol
Parameters
- store: KEY
- key: string
- Optional index: string
Returns Promise<undefined | SCHEMA[KEY]>
- Defined in src/game/ui/util/Database.ts:45

getDatabase

getDatabase(): Promise<IDBDatabase>
Returns Promise<IDBDatabase>
- Defined in src/game/ui/util/Database.ts:33

hasStore

hasStore(...stores: (keyof SCHEMA)[]): Promise<boolean>
Parameters
- Rest ...stores: (keyof SCHEMA)[]
Returns Promise<boolean>
- Defined in src/game/ui/util/Database.ts:105

keys

keys(store: keyof SCHEMA): Promise<string[]>
Parameters
- store: keyof SCHEMA
Returns Promise<string[]>
- Defined in src/game/ui/util/Database.ts:63

set

set<KEY>(store: KEY, key: string, value: SCHEMA[KEY]): Promise<void>
Type Parameters
- KEY extends string | number | symbol
Parameters
- store: KEY
- key: string
- value: SCHEMA[KEY]
Returns Promise<void>
- Defined in src/game/ui/util/Database.ts:55

stagedTransaction

stagedTransaction<STORES>(over: STORES, mode?: IDBTransactionMode): StagedTransaction<Pick<SCHEMA, STORES[number]>, STORES>
Type Parameters
- STORES extends (keyof SCHEMA)[]
Parameters
- over: STORES
- mode: IDBTransactionMode = "readwrite"
Returns StagedTransaction<Pick<SCHEMA, STORES[number]>, STORES>
- Defined in src/game/ui/util/Database.ts:90

stores

stores(): Promise<DOMStringList>
Returns Promise<DOMStringList>
- Defined in src/game/ui/util/Database.ts:100

transaction

transaction<STORES, T>(over: STORES, mode: IDBTransactionMode, transaction: Initialiser<SCHEMA, STORES, T>): Promise<T>
Type Parameters
- STORES extends (keyof SCHEMA)[]
- T
Parameters
- over: STORES
- mode: IDBTransactionMode
- transaction: Initialiser<SCHEMA, STORES, T>
Returns Promise<T>
- Defined in src/game/ui/util/Database.ts:75
transaction<STORES, T>(over: STORES, transaction: Initialiser<SCHEMA, STORES, T>): Promise<T>
Type Parameters
- STORES extends (keyof SCHEMA)[]
- T
Parameters
- over: STORES
- transaction: Initialiser<SCHEMA, STORES, T>
Returns Promise<T>
- Defined in src/game/ui/util/Database.ts:76

upgrade

upgrade(upgrade: Upgrade): Promise<void>
Parameters
- upgrade: Upgrade
Returns Promise<void>
- Defined in src/game/ui/util/Database.ts:94

Class default<SCHEMA>

Type Parameters

SCHEMA

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

SCHEMA

Parameters

schema: Schema<SCHEMA>

Returns default<SCHEMA>

Properties

Readonly event

Methods

all

Type Parameters

KEY extends string | number | symbol

Parameters

store: KEY

Optional range: IDBKeyRange

Returns Promise<SCHEMA[KEY][]>

Type Parameters

KEY extends string | number | symbol

Parameters

store: KEY

key: string | IDBKeyRange

index: string

Returns Promise<SCHEMA[KEY][]>

clear

Parameters

store: keyof SCHEMA

Returns Promise<void>

count

Parameters

store: keyof SCHEMA

Returns Promise<number>

createStore

Parameters

store: keyof SCHEMA

Optional options: IDBObjectStoreParameters

Optional init: ((store: IDBObjectStore) => any)

Parameters

store: IDBObjectStore

Returns any

Returns Promise<void>

delete

Parameters

store: keyof SCHEMA

key: string

Returns Promise<void>

dispose

Returns Promise<void>

get

Type Parameters

KEY extends string | number | symbol

Parameters

store: KEY

key: string

Optional index: string

Returns Promise<undefined | SCHEMA[KEY]>

getDatabase

Returns Promise<IDBDatabase>

hasStore

Parameters

Rest ...stores: (keyof SCHEMA)[]

Returns Promise<boolean>

keys

Parameters

store: keyof SCHEMA

Returns Promise<string[]>

set

Type Parameters

KEY extends string | number | symbol

Parameters

store: KEY

key: string

`Readonly` event

`Optional` range: IDBKeyRange

`Optional` options: IDBObjectStoreParameters

`Optional` init: ((store: IDBObjectStore) => any)

`Optional` index: string

`Rest` ...stores: (keyof SCHEMA)[]