Class default

This model implements the possibility of adding a diary entry into a journal and keeping track of the list of the diary entries

Hierarchy (View Summary)

Model
- default

Index

Constructors

Properties

channelManager onUpdated state channelId

Methods

addEntry entries entriesIterator getEntryById init shutdown

Constructors

constructor

new default(channelManager: default): default
Construct a new instance
Parameters
- channelManager: default
  The channel manager instance
Returns default
Overrides Model.constructor
- Defined in models/DiaryModel.ts:63

Properties

channelManager

channelManager: default

onUpdated

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

state

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

`Static` `Readonly`channelId

channelId: "diary" = 'diary'

Methods

addEntry

addEntry(diaryEntry: string, owner?: SHA256IdHash<Person>): Promise<void>
Parameters
- diaryEntry: string
- Optionalowner: SHA256IdHash<Person>
Returns Promise<void>
- Defined in models/DiaryModel.ts:95

entries

entries(): Promise<ObjectData<string>[]>
Returns Promise<ObjectData<string>[]>
- Defined in models/DiaryModel.ts:108

entriesIterator

entriesIterator(
queryOptions?: QueryOptions,
): AsyncIterableIterator<ObjectData<DiaryEntry>>
returns iterator for Diary Entries
Parameters
- OptionalqueryOptions: QueryOptions
Returns AsyncIterableIterator<ObjectData<DiaryEntry>>
- Defined in models/DiaryModel.ts:129

getEntryById

getEntryById(id: string): Promise<ObjectData<string>>
Parameters
- id: string
Returns Promise<ObjectData<string>>
- Defined in models/DiaryModel.ts:142

init

init(): Promise<void>
Initialize this instance

This must be done after the one instance was initialized.

Returns Promise<void>
- Defined in models/DiaryModel.ts:74

shutdown

shutdown(): Promise<void>
Shutdown module

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