Class OutgoingResponse

Class representing an OutgoingResponse.

Hierarchy (View Summary)

Event
- OutgoingResponse

Index

Constructors

`Protected`constructor

new OutgoingResponse(options: OutgoingResponseOptions): OutgoingResponse
Create an OutgoingResponse.
Parameters
- options: OutgoingResponseOptions
  The options to create an OutgoingResponse.
Returns OutgoingResponse

Overrides Event.constructor

Properties

`Protected`_content

_content: unknown

The content of the response.

`Protected` `Optional`_statusCode

_statusCode?: number

The status code of the response.

`Protected` `Optional`_statusMessage

_statusMessage?: string

The status message of the response.

`Readonly`metadata

metadata: Record<string, unknown>

The metadata associated with the event.

`Readonly`originalContent

originalContent: unknown

The original content of the response.

`Protected`prepared

prepared: boolean

The prepared status of the response.

`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.

Accessors

content

get content(): unknown

Gets the content of the outgoing response.

Returns unknown
The content of the outgoing response.

isPrepared

get isPrepared(): boolean

Gets the prepared status of the outgoing response.

Returns boolean
The prepared status of the response.

statusCode

get statusCode(): number

Gets the status code of the outgoing response.

Returns number
The status code of the response, or undefined if not set.

statusMessage

get statusMessage(): string

Gets the status message of the outgoing response.

Returns string
The status message of the response, or undefined if not set.

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

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

prepare

prepare(
_event: IncomingEvent,
_container?: Container,
): Promiseable<OutgoingResponse>
Prepare response before sending it.
Parameters
- _event: IncomingEvent
  The incoming event associated with this response.
- Optional_container: Container
  The container.
Returns Promiseable<OutgoingResponse>
This OutgoingResponse instance.

setContent

setContent(content: unknown): this
Set the content of the response.
Parameters
- content: unknown
  The content to set.
Returns this
This OutgoingResponse instance.

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

setPrepared

setPrepared(prepared: boolean): this
Set the prepared status of the response.
Parameters
- prepared: boolean
  The prepared status to set.
Returns this
This OutgoingResponse instance.

setStatus

setStatus(code: number, text?: string): this
Set the status code of the response.
Parameters
- code: number
  The status code.
- Optionaltext: string
  Optional status message.
Returns this
This OutgoingResponse instance.

`Static`create

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

Events

`Static` `Readonly`OUTGOING_RESPONSE

OUTGOING_RESPONSE: string = 'stonejs@outgoing_response'

OUTGOING_RESPONSE Event name, fires on response to the incoming event.

OutgoingResponse#OUTGOING_RESPONSE

Class OutgoingResponse

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

Protectedconstructor

Parameters

Returns OutgoingResponse

Properties

Protected_content

Protected Optional_statusCode

Protected Optional_statusMessage

Readonlymetadata

ReadonlyoriginalContent

Protectedprepared

Optional Readonlysource

ReadonlytimeStamp

Readonlytype

Accessors

content

Returns unknown

isPrepared

Returns boolean

statusCode

Returns number

statusMessage

Returns string

Methods

clone

Returns this

get

Type Parameters

Parameters

Returns TReturn

Type Parameters

Parameters

Returns TReturn

getMetadataValue

Type Parameters

Parameters

Returns TReturn

Type Parameters

Parameters

Returns TReturn

is

Parameters

Returns boolean

prepare

Parameters

Returns Promiseable<OutgoingResponse>

setContent

Parameters

Returns this

setMetadataValue

Parameters

Returns this

setPrepared

Parameters

Returns this

setStatus

Parameters

Returns this

Staticcreate

Parameters

Returns OutgoingResponse

Events

Static ReadonlyOUTGOING_RESPONSE

Settings

On This Page

`Protected`constructor

`Protected`_content

`Protected` `Optional`_statusCode

`Protected` `Optional`_statusMessage

`Readonly`metadata

`Readonly`originalContent

`Protected`prepared

`Optional` `Readonly`source

`Readonly`timeStamp

`Readonly`type

`Static`create

`Static` `Readonly`OUTGOING_RESPONSE