MutableDB | redux-database

Type parameters

State: StateDefining

Hierarchy

MutableDB

Index

Constructors

constructor

Properties

Accessors

snapshot

Methods

Constructors

constructor

new MutableDB(state: State, options?: { context?: undefined | string; store?: Store<State> }): MutableDB

- Defined in mutable_db.ts:23
Parameters
- state: State
- Default value options: { context?: undefined | string; store?: Store<State> } = {}
  - Optional context?: undefined | string
  - Optional store?: Store<State>
Returns MutableDB

Properties

Private cachedTables

cachedTables: {}

Type declaration

[key: string]: MutableTable<Row>

Private Optional currentContext

currentContext: undefined | string

Private reducer

reducer: (state: State, action: DBAction) => State

Type declaration

- (state: State, action: DBAction): State
- Parameters
  - state: State
  - action: DBAction
  Returns State

Private state

state: State

Private Optional store

store: Store<State>

Private subscribers

subscribers: Array<(action: DBAction) => void>

Accessors

snapshot

get snapshot(): DB<State>

- Defined in mutable_db.ts:42
Returns DB<State>

Methods

commit

commit<K>(table?: K, ids?: RowIdentififying): void

- Defined in mutable_db.ts:93
Type parameters
- K: RowKeyOf<State>
Parameters
- Optional table: K
- Optional ids: RowIdentififying
Returns void

context

context(context: string): MutableDB<State>

- Defined in mutable_db.ts:81
Parameters
- context: string
Returns MutableDB<State>

Private dispatch

dispatch(action: DBAction): void

- Defined in mutable_db.ts:126
Parameters
- action: DBAction
Returns void

get

get<K>(name: K): SettingsType<State, K>

- Defined in mutable_db.ts:46
Type parameters
- K: SettingsKey<State>
Parameters
- name: K
Returns SettingsType<State, K>

observe

observe<T>(query: (db: DB<State>) => T): Subscription<State, T>

- Defined in mutable_db.ts:122
Type parameters
- T
Parameters
- query: (db: DB<State>) => T
  - - (db: DB<State>): T
    - Parameters
      - db: DB<State>
      Returns T
Returns Subscription<State, T>

query

query<Key>(type: Key): Query<State, Key, RowType<State, Key>>

- Defined in mutable_db.ts:74
Type parameters
- Key: RowKeyOf<State>
Parameters
- type: Key
Returns Query<State, Key, RowType<State, Key>>

Private readState

readState(state: State): void

- Defined in mutable_db.ts:135
Parameters
- state: State
Returns void

reset

reset(type?: "all" | "tables" | "settings"): void

- Defined in mutable_db.ts:111
Parameters
- Default value type: "all" | "tables" | "settings" = "all"
Returns void

revert

revert<K>(table?: K, ids?: RowIdentififying): void

- Defined in mutable_db.ts:100
Type parameters
- K: RowKeyOf<State>
Parameters
- Optional table: K
- Optional ids: RowIdentififying
Returns void

set

set<K, U>(name: K, value: U): void

- Defined in mutable_db.ts:50
Type parameters
- K: SettingsKey<State>
- U: SettingsType<State, K>
Parameters
- name: K
- value: U
Returns void

subscribe

subscribe(callback: (action: DBAction) => void): () => void

- Defined in mutable_db.ts:115
Parameters
- callback: (action: DBAction) => void
  - - (action: DBAction): void
    - Parameters
      - action: DBAction
      Returns void
Returns () => void
- - (): void
  - Returns void

table

table<K>(type: K): MutableTable<RowType<State, K>>

- Defined in mutable_db.ts:57
Type parameters
- K: RowKeyOf<State>
Parameters
- type: K
Returns MutableTable<RowType<State, K>>

transaction

transaction(execute: (db: DB<State>, dispatch: DBDispatch) => void): void

- Defined in mutable_db.ts:85
Parameters
- execute: (db: DB<State>, dispatch: DBDispatch) => void
  - - (db: DB<State>, dispatch: DBDispatch): void
    - Parameters
      - db: DB<State>
      - dispatch: DBDispatch
      Returns void
Returns void

truncate

truncate(): void

- Defined in mutable_db.ts:107
Returns void

Generated using TypeDoc