Interface EventBehavior<T>

Interface that defines the behavior of an event.

interface EventBehavior<T extends EnvelopeEncodableValue> {
    withNote(note: string): Event<T>;
    withDate(date: Date): Event<T>;
    content(): T;
    id(): ARID;
    note(): string;
    date(): Date | undefined;
    toEnvelope(): Envelope;
}

Type Parameters

T extends EnvelopeEncodableValue

Implemented by

Event

Index

Methods

withNote withDate content id note date toEnvelope

Methods

withNote

withNote(note: string): Event<T>
Adds a note to the event.
Parameters
- note: string
Returns Event<T>
- Defined in envelope/src/extension/event.ts:37

withDate

withDate(date: Date): Event<T>
Adds a date to the event.
Parameters
- date: Date
Returns Event<T>
- Defined in envelope/src/extension/event.ts:42

content

content(): T
Returns the content of the event.

Returns T
- Defined in envelope/src/extension/event.ts:47

id

id(): ARID
Returns the unique identifier (ARID) of the event.

Returns ARID
- Defined in envelope/src/extension/event.ts:52

note

note(): string
Returns the note attached to the event, or an empty string if none exists.

Returns string
- Defined in envelope/src/extension/event.ts:57

date

date(): Date | undefined
Returns the date attached to the event, if any.

Returns Date | undefined
- Defined in envelope/src/extension/event.ts:62

toEnvelope

toEnvelope(): Envelope
Converts the event to an envelope.

Returns Envelope
- Defined in envelope/src/extension/event.ts:67