Class default

This model implements a broadcast channel.

Hierarchy (View Summary)

Model
- default

Index

Constructors

Properties

channelManager onUpdated state

Methods

addFeedback addNews entries init shutdown

Constructors

constructor

new default(channelManager: default): default
Parameters
- channelManager: default
Returns default
Overrides Model.constructor
- Defined in models/NewsModel.ts:53

Properties

channelManager

channelManager: default

Event emitted when news or feedback data is updated.

onUpdated

onUpdated: OEvent<(timeOfEarliestChange: Date) => void> = ...

state

state: StateMachine<"Uninitialised" | "Initialised", "shutdown" | "init">

Methods

addFeedback

addFeedback(content: string): Promise<void>
Parameters
- content: string
Returns Promise<void>
- Defined in models/NewsModel.ts:91

addNews

addNews(content: string): Promise<void>
Parameters
- content: string
Returns Promise<void>
- Defined in models/NewsModel.ts:85

entries

entries(channelId: string): Promise<ObjectData<News>[]>
retrieve the news or feedback depending on the channel id provided
Parameters
- channelId: string
Returns Promise<ObjectData<News>[]>
- Defined in models/NewsModel.ts:101

init

init(): Promise<void>
Initialize this instance of the feedback and news channel This must be done after the one instance was initialized.

Returns Promise<void>
- Defined in models/NewsModel.ts:63

shutdown

shutdown(): Promise<void>
Shutdown module

Returns Promise<void>
Overrides Model.shutdown
- Defined in models/NewsModel.ts:76