Class Messages

A class for building and working with messages grouped by keys.

Hierarchy

Messages

Implements

Rehydratable

Index

Constructors

constructor

Properties

messages

Methods

Constructors

constructor

new Messages(allMessages?: string[]): Messages

- Defined in src/util/support/Messages.ts:9
Parameters
- Optional allMessages: string[]
Returns Messages

Properties

Protected messages

messages: {} = {}

Type declaration

[key: string]: string[]

Methods

all

all(forKey?: string): string[]

- Defined in src/util/support/Messages.ts:72
Return all messages in a flat array.

Parameters
- Optional forKey: string
Returns string[]

any

any(forKeys?: string[]): boolean

- Defined in src/util/support/Messages.ts:44
Returns true if any messages are found.

Parameters
- Optional forKeys: string[]
Returns boolean

count

count(forKey?: string): number

- Defined in src/util/support/Messages.ts:94
Get the total number of messages.

Parameters
- Optional forKey: string
Returns number

dehydrate

dehydrate(): Promise<JSONState>

Implementation of Rehydratable.dehydrate
- Defined in src/util/support/Messages.ts:98
Dehydrate this class' state and get it.

Returns Promise<JSONState>

JSONState|Promise

first

first(forKey?: string): undefined | string

- Defined in src/util/support/Messages.ts:58
Returns the first message.

Parameters
- Optional forKey: string
Returns undefined | string

has

has(key: string, message: string): boolean

- Defined in src/util/support/Messages.ts:36
Returns true if the given group has the message.

Parameters
- key: string
- message: string
Returns boolean

keys

keys(): string[]

- Defined in src/util/support/Messages.ts:21
All group keys of messages.

Returns string[]

pipe

pipe(): Pipe<Messages>

- Defined in src/util/support/Messages.ts:136
Get a new Pipe object wrapping this instance.

Returns Pipe<Messages>

put

put(key: string, message: string): Messages

- Defined in src/util/support/Messages.ts:26
Add a message to a group.

Parameters
- key: string
- message: string
Returns Messages

rehydrate

rehydrate(state: JSONState): void

Implementation of Rehydratable.rehydrate
- Defined in src/util/support/Messages.ts:102
Rehydrate a state into this class.

Parameters
- state: JSONState
Returns void

void|Promise

toJSON

toJSON(): {}

- Defined in src/util/support/Messages.ts:125
Returns {}
- [key: string]: string[]

toString

toString(): string

- Defined in src/util/support/Messages.ts:129
Returns string

unique

unique(forKey?: string): string[]

- Defined in src/util/support/Messages.ts:85
Flat array of only distinct messages.

Parameters
- Optional forKey: string
Returns string[]

extollo (v. latin) - to lift up, to elevate

Extollo is a free & libre application framework in TypeScript.