Class Event`Abstract`

Class representing an Event.

Author

Mr. Stone evensstone@gmail.com

Hierarchy (View Summary)

Event
- IncomingEvent
- OutgoingResponse

Index

Constructors

Properties

metadata source? timeStamp type

Methods

clone get getMetadataValue is setMetadataValue

Constructors

`Protected`constructor

new Event(options: EventOptions): Event
Create an Event.
Parameters
- options: EventOptions
  The options to create an Event.
Returns Event

Properties

`Readonly`metadata

metadata: Record<string, unknown>

The metadata associated with the event.

`Optional` `Readonly`source

source?: object

The source of the event.

`Readonly`timeStamp

timeStamp: number

The timestamp of the event creation.

`Readonly`type

type: string

The type of the event.

Methods

clone

clone(): this

Return a cloned instance.

The metadata container is deep-copied (plain objects and arrays are recreated, special values kept by reference) so that mutating the clone's metadata — e.g. via middleware — never leaks back into the original event. This is what makes the Kernel's originalEvent snapshot a faithful pre-middleware copy.

Returns this
A cloned instance of the current class.

get

get<TReturn = unknown>(key: string): TReturn
Get data from metadata.
Type Parameters
- TReturn = unknown
Parameters
- key: string
  The key to retrieve from metadata.
Returns TReturn
The value associated with the key or the fallback.
get<TReturn = unknown>(key: string, fallback: TReturn): TReturn
Get data from metadata.
Type Parameters
- TReturn = unknown
Parameters
- key: string
  The key to retrieve from metadata.
- fallback: TReturn
  The fallback value if the key is not found.
Returns TReturn
The value associated with the key or the fallback.

getMetadataValue

getMetadataValue<TReturn = unknown>(key: string): TReturn
Get data from metadata.
Type Parameters
- TReturn = unknown
Parameters
- key: string
  The key to retrieve from metadata.
Returns TReturn
The value associated with the key or the fallback.
getMetadataValue<TReturn = unknown>(key: string, fallback: TReturn): TReturn
Get data from metadata.
Type Parameters
- TReturn = unknown
Parameters
- key: string
  The key to retrieve from metadata.
- fallback: TReturn
  The fallback value if the key is not found.
Returns TReturn
The value associated with the key or the fallback.

is

is(key: string, value: unknown): boolean
Check if the given value is equal to the specified value.
Parameters
- key: string
  The key to check.
- value: unknown
  The value to compare against.
Returns boolean
True if the key's value is equal to the specified value, false otherwise.

setMetadataValue

setMetadataValue(key: string | Record<string, unknown>, value?: unknown): this
Add data to metadata.
Parameters
- key: string | Record<string, unknown>
  The key or object to add to metadata.
- Optionalvalue: unknown
  The value to associate with the key.
Returns this
This Event instance.