Class IncomingEvent

Class representing an IncomingEvent.

Author

Mr. Stone evensstone@gmail.com

Hierarchy (View Summary)

Event
- IncomingEvent

Index

Constructors

Properties

locale metadata source timeStamp type

Accessors

Methods

clone fingerprint get getMetadataValue is isPlatform setMetadataValue create

Events

Constructors

`Protected`constructor

new IncomingEvent(options: IncomingEventOptions): IncomingEvent
Create an IncomingEvent.
Parameters
- options: IncomingEventOptions
  The options to create an IncomingEvent.
Returns IncomingEvent

Overrides Event.constructor

Properties

`Readonly`locale

locale: string

The locale of the event.

`Readonly`metadata

metadata: Record<string, unknown>

The metadata associated with the event.

`Readonly`source

source: IncomingEventSource

The source of the event.

`Readonly`timeStamp

timeStamp: number

The timestamp of the event creation.

`Readonly`type

type: string

The type of the event.

Accessors

platform

get platform(): string | symbol

Get the platform of the event source.

Returns string | symbol
The platform of the event source.

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.

Inherited from Event.clone

fingerprint

fingerprint(): string

A stable identity for this event.

What it is for: keying anything that has to survive one event being handled twice. A renderer stores its loader results under this key on the server and reads them back under the same key in the browser, so two renders of the same event find the same data.

Defined here because identity is not a platform's idea. An event that carries a URL has a sharper one to offer and overrides this: IncomingHttpEvent and IncomingBrowserEvent both answer with their method and path. An event that carries a payload instead, from a queue or a timer, is identified by that payload, which is what this computes.

Two properties it must have, and both come from what is excluded: the timestamp is left out, because a server render and a browser render of the same event happen at different moments and must agree; and keys are sorted, because two objects with the same entries in a different order are the same event.

Returns string
The fingerprint, base64-encoded.

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.

Inherited from Event.get
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.

Inherited from Event.get

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.

Inherited from Event.getMetadataValue
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.

Inherited from Event.getMetadataValue

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.

Inherited from Event.is

isPlatform

isPlatform(platform: string | symbol): boolean
Check if the event source is from a platform.
Parameters
- platform: string | symbol
  The platform to check.
Returns boolean
True if the event source is from the platform, 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.

Inherited from Event.setMetadataValue

`Static`create

create(options: IncomingEventOptions): IncomingEvent
Create an IncomingEvent.
Parameters
- options: IncomingEventOptions
  The options to create an IncomingEvent.
Returns IncomingEvent
A new IncomingEvent instance.

Events

`Static` `Readonly`INCOMING_EVENT

INCOMING_EVENT: string = 'stonejs@incoming_event'

INCOMING_EVENT Event name, fires on platform message.

IncomingEvent#INCOMING_EVENT