Interface IKeyValueDatabase

Interface for a key-value database.

interface IKeyValueDatabase {
    close(): void;
    getName(): string;
    getOwnerId(): string;
    getTable<T>(tableName): IDatabaseTable<T>;
    subscribe(callback): void;
    unsubscribe(): void;
}

Hierarchy (view full)

IDataStream
- IKeyValueDatabase

Index

Methods

close getName getOwnerId getTable subscribe unsubscribe

Methods

close

close(): void
Close the database.

Returns void

getName

getName(): string
Get the name of the database.

Returns string
Overrides IDataStream.getName

getOwnerId

getOwnerId(): string
Get the owner ID of the database.

Returns string
Overrides IDataStream.getOwnerId

getTable

getTable<T>(tableName): IDatabaseTable<T>
Gets the table with the given name.
Type Parameters
- T extends IValueType
Parameters
- tableName: string
  The name of the table to get.
Returns IDatabaseTable<T>
The table.

subscribe

subscribe(callback): void
Subscribe to datase events.
Parameters
- callback: ((event) => void)
  The callback to call when a database event is published.
  - - (event): void
    - Parameters
      event: IDatabaseEvent
      Returns void
Returns void

unsubscribe

unsubscribe(): void
Unsubscribe from database events.

Returns void

Generated using TypeDoc