Class DbmsStore`Abstract`

A store with a kind and an open flag.

💡 Pass the kind and the open flag to super from your subclass constructor.

Example

import { DbmsStore, StoreType } from "@itsaorg/dbms-base";

class Docs extends DbmsStore {
  constructor() {
    super(StoreType.Docstore, false);
  }
}

Index

Constructors

constructor

Properties

opened storeType

Methods

emit off on

Constructors

`Protected`constructor

new DbmsStore(storeType: StoreType, opened: boolean): DbmsStore
Records the store kind and whether it is open.
Parameters
- storeType: StoreType
  The kind of data this store holds.
- opened: boolean
  True when the store is ready.
Returns DbmsStore
Overrides DbmsEventEmitter.constructor
- Defined in src/base/DbmsStore.ts:35

Properties

`Readonly`opened

opened: boolean

True after the store has opened.

`Readonly`storeType

storeType: StoreType

The kind of data this store holds.

Methods

emit

emit<K extends keyof DbmsEventMap>(event: K, payload: DbmsEventMap[K]): void
Calls every listener registered for an event name.
Type Parameters
- K extends keyof DbmsEventMap
Parameters
- event: K
  The event to send.
- payload: DbmsEventMap[K]
  The value listeners receive.
Returns void
Implementation of DbmsStoreInterface.emit

Inherited from DbmsEventEmitter.emit
- Defined in src/base/DbmsEventEmitter.ts:58

off

off<K extends keyof DbmsEventMap>(
event: K,
listener: (payload: DbmsEventMap[K]) => void,
): void
Removes one listener for an event name.
Type Parameters
- K extends keyof DbmsEventMap
Parameters
- event: K
  The event the listener was registered for.
- listener: (payload: DbmsEventMap[K]) => void
  The same function passed to on.
Returns void
Implementation of DbmsStoreInterface.off

Inherited from DbmsEventEmitter.off
- Defined in src/base/DbmsEventEmitter.ts:46

on

on<K extends keyof DbmsEventMap>(
event: K,
listener: (payload: DbmsEventMap[K]) => void,
): void
Registers a listener for one event name.
Type Parameters
- K extends keyof DbmsEventMap
Parameters
- event: K
  The event to listen for.
- listener: (payload: DbmsEventMap[K]) => void
  Called with that event's payload.
Returns void
Implementation of DbmsStoreInterface.on

Inherited from DbmsEventEmitter.on
- Defined in src/base/DbmsEventEmitter.ts:33

Class DbmsStore`Abstract`

Example

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

`Protected`constructor

Parameters

Returns DbmsStore

Properties

`Readonly`opened

`Readonly`storeType

Methods

emit

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

Settings

On This Page

Class DbmsStoreAbstract

Example

See

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

Protectedconstructor

Parameters

Returns DbmsStore

Properties

Readonlyopened

ReadonlystoreType

Methods

emit

Type Parameters

Parameters

Returns void

off

Type Parameters

Parameters

Returns void

on

Type Parameters

Parameters

Returns void

Settings

On This Page

Class DbmsStore`Abstract`

`Protected`constructor

`Readonly`opened

`Readonly`storeType