Class Event<T>

An Event represents a notification or message that doesn't expect a response.

Example

import { Event, ARID } from '@bcts/envelope';

// Create a status update event
const eventId = ARID.new();
const timestamp = new Date("2024-08-15T13:45:30Z");

const statusEvent = Event.new("System online", eventId)
  .withNote("Regular status update")
  .withDate(timestamp);

// Convert to an envelope for transmission
const envelope = statusEvent.toEnvelope();

Type Parameters

T extends EnvelopeEncodableValue
The type of content this event carries

Implements

EventBehavior<T>

Index

Methods

new summary withNote withDate content id note date toEnvelope fromEnvelope stringFromEnvelope toString equals

Methods

`Static`new

new<T extends EnvelopeEncodableValue>(content: T, id: ARID): Event<T>
Creates a new event with the specified content and ID.
Type Parameters
- T extends EnvelopeEncodableValue
Parameters
- content: T
- id: ARID
Returns Event<T>
- Defined in envelope/src/extension/event.ts:107

summary

summary(): string
Returns a human-readable summary of the event.

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

withNote

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

withDate

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

content

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

Returns T
Implementation of EventBehavior.content
- Defined in envelope/src/extension/event.ts:131

id

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

Returns ARID
Implementation of EventBehavior.id
- Defined in envelope/src/extension/event.ts:135

note

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

Returns string
Implementation of EventBehavior.note
- Defined in envelope/src/extension/event.ts:139

date

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

Returns Date | undefined
Implementation of EventBehavior.date
- Defined in envelope/src/extension/event.ts:143

toEnvelope

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

The envelope's subject is the event's ID tagged with TAG_EVENT, and assertions include the event's content, note (if not empty), and date (if present).

Returns Envelope
Implementation of EventBehavior.toEnvelope
- Defined in envelope/src/extension/event.ts:154

`Static`fromEnvelope

fromEnvelope<T extends EnvelopeEncodableValue>(
envelope: Envelope,
contentExtractor: (env: Envelope) => T,
): Event<T>
Creates an event from an envelope.
Type Parameters
- T extends EnvelopeEncodableValue
  The type to extract the content as
Parameters
- envelope: Envelope
- contentExtractor: (env: Envelope) => T
Returns Event<T>
- Defined in envelope/src/extension/event.ts:176

`Static`stringFromEnvelope

stringFromEnvelope(envelope: Envelope): Event<string>
Creates a string event from an envelope.
Parameters
- envelope: Envelope
Returns Event<string>
- Defined in envelope/src/extension/event.ts:221

toString

toString(): string
Returns a string representation of the event.

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

equals

equals(other: Event<T>): boolean
Checks equality with another event.
Parameters
- other: Event<T>
Returns boolean
- Defined in envelope/src/extension/event.ts:235

Class Event<T>

Example

Type Parameters

Implements

Index

Methods

Methods

Staticnew

Type Parameters

Parameters

Returns Event<T>

summary

Returns string

withNote

Parameters

Returns Event<T>

withDate

Parameters

Returns Event<T>

content

Returns T

id

Returns ARID

note

Returns string

date

Returns Date | undefined

toEnvelope

Returns Envelope

StaticfromEnvelope

Type Parameters

Parameters

Returns Event<T>

StaticstringFromEnvelope

Parameters

Returns Event<string>

toString

Returns string

equals

Parameters

Returns boolean

Settings

On This Page

`Static`new

`Static`fromEnvelope

`Static`stringFromEnvelope