Class IncomingBrowserEvent

Class representing an IncomingBrowserEvent.

Author

Mr. Stone evensstone@gmail.com

Hierarchy

IncomingEvent
- IncomingBrowserEvent

Index

Constructors

`Protected`constructor

new IncomingBrowserEvent(
options: IncomingBrowserEventOptions,
): IncomingBrowserEvent
Constructor for IncomingBrowserEvent.
Parameters
- options: IncomingBrowserEventOptions
  The options to create an IncomingBrowserEvent instance.
Returns IncomingBrowserEvent

Throws
If the URL option is not a valid instance of URL.

Overrides IncomingEvent.constructor

Properties

`Readonly`cookies

cookies: CookieCollection

The cookies included in the request.

`Readonly`locale

locale: string

The locale of the event.

`Readonly`metadata

metadata: Record<string, unknown>

The metadata associated with the event.

`Readonly`method

method: "GET"

The HTTP method of the request.

`Readonly`protocol

protocol: string

The protocol used for the request (e.g., http or https).

`Readonly`query

query: URLSearchParams

The query parameters of the request.

`Optional` `Readonly`queryString

queryString?: string

The query string of the request.

`Protected` `Optional`routeResolver

routeResolver?: () => IRoute

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

`Readonly`url

url: URL

The URL of the request.

`Protected` `Optional`userResolver

userResolver?: () => unknown

`Static` `Readonly`INCOMING_BROWSER_EVENT

INCOMING_BROWSER_EVENT: "stonejs@incoming_browser_event" = 'stonejs@incoming_browser_event'

Accessors

decodedPathname

get decodedPathname(): string

Returns string
The decoded pathname of the URL.

hash

get hash(): string

Returns string
The hash part of the URL.

host

get host(): string

Returns string
The host of the URL (hostname:port).

hostname

get hostname(): string

Returns string
The hostname of the URL.

isSecure

get isSecure(): boolean

Returns boolean
Whether the request was made over a secure connection.

params

get params(): Record<string, unknown>

Returns Record<string, unknown>
The route parameters.

path

get path(): string

Returns string
The full path including pathname and search query.

pathname

get pathname(): string

Returns string
The pathname of the URL.

platform

get platform(): string | symbol

Get the platform of the event source.

Returns string | symbol
The platform of the event source.

Inherited from IncomingEvent.platform

scheme

get scheme(): string

Returns string
The protocol of the URL (e.g., "http" or "https").

segments

get segments(): string[]

Returns string[]
The URL segments split by '/'.

uri

get uri(): string

Returns string
The full URL as a string.

userAgent

get userAgent(): string

Returns string
The user agent, or undefined outside a browser (SSR/tests/workers).

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 IncomingEvent.clone

fingerprint

fingerprint(): string

Generate a unique fingerprint for the event.

Returns string
The generated fingerprint as a base64 string.

Overrides IncomingEvent.fingerprint

get

get<TReturn = unknown>(key: string): TReturn
Get data from the request.

Priority:
1. Route params
2. Query params
3. Cookies
4. Metadata
5. Fallback value
Type Parameters
- TReturn = unknown
Parameters
- key: string
  The key to look for.
Returns TReturn
The value of the key or the fallback.

Overrides IncomingEvent.get
get<TReturn = unknown>(key: string, fallback: TReturn): TReturn
Get data from the request.

Priority:
1. Route params
2. Query params
3. Cookies
4. Metadata
5. Fallback value
Type Parameters
- TReturn = unknown
Parameters
- key: string
  The key to look for.
- fallback: TReturn
  A fallback value if the key is not found.
Returns TReturn
The value of the key or the fallback.

Overrides IncomingEvent.get

getCookie

getCookie<TReturn extends Cookie = Cookie>(name: string): TReturn
Get a cookie value.
Type Parameters
- TReturn extends Cookie = Cookie
Parameters
- name: string
  The cookie name.
Returns TReturn
The cookie value or the fallback.
getCookie<TReturn extends Cookie = Cookie>(
name: string,
fallback: TReturn,
): TReturn
Get a cookie value.
Type Parameters
- TReturn extends Cookie = Cookie
Parameters
- name: string
  The cookie name.
- fallback: TReturn
  A fallback value if the cookie is not found.
Returns TReturn
The cookie value 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.

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

getParam

getParam<TReturn = unknown>(name: string): TReturn
Retrieve a parameter from the route if it exists.
Type Parameters
- TReturn = unknown
Parameters
- name: string
  The name of the parameter to retrieve.
Returns TReturn
The value of the parameter if it exists, otherwise undefined.
getParam<TReturn = unknown>(name: string, fallback: TReturn): TReturn
Retrieve a parameter from the route if it exists.
Type Parameters
- TReturn = unknown
Parameters
- name: string
  The name of the parameter to retrieve.
- fallback: TReturn
  The fallback value if the parameter does not exist.
Returns TReturn
The value of the parameter if it exists, otherwise undefined.

getRoute

getRoute<RouteType extends IRoute = IRoute>(): RouteType
Return the current route or a route parameter.
Type Parameters
- RouteType extends IRoute = IRoute
Returns RouteType
The route parameter or the route object.

getRouteResolver

getRouteResolver(): () => IRoute

Get the route resolver function.

Returns () => IRoute
The route resolver function.

getUri

getUri(withDomain?: boolean): string
Get the URI with or without the domain.
Parameters
- withDomain: boolean = false
  Whether to include the domain in the URI.
Returns string
The URI with or without the domain.

getUser

getUser<T = undefined>(): T
Get the user instance.
Type Parameters
- T = undefined
Returns T
The user object, resolved through a user resolver function if available.

getUserResolver

getUserResolver(): () => unknown

Get the user resolver function.

Returns () => unknown
The user resolver function.

hasCookie

hasCookie(name: string): boolean
Check if a cookie exists.
Parameters
- name: string
  The cookie name to check.
Returns boolean
True if the cookie exists, otherwise false.

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 IncomingEvent.is

isMethod

isMethod(method: string): boolean
Check if the current event method matches the given method.
Parameters
- method: string
  The method to check.
Returns boolean
True if the event method matches, otherwise false.

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.

Inherited from IncomingEvent.isPlatform

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 IncomingEvent.setMetadataValue

setRouteResolver

setRouteResolver<RouteType extends IRoute = IRoute>(
resolver: () => RouteType,
): this
Set the route resolver function.
Type Parameters
- RouteType extends IRoute = IRoute
Parameters
- resolver: () => RouteType
  The route resolver function.
Returns this
The current instance for method chaining.

setUserResolver

setUserResolver(resolver: () => unknown): this
Set the user resolver function.
Parameters
- resolver: () => unknown
  The user resolver function.
Returns this
The current instance for method chaining.

uriForPath

uriForPath(path: string): string
Generate a full URL for the given path.
Parameters
- path: string
  The path to append to the base URL.
Returns string
The full URL for the given path.

`Static`create

create(options: IncomingBrowserEventOptions): IncomingBrowserEvent
Create an IncomingBrowserEvent.
Parameters
- options: IncomingBrowserEventOptions
  The IncomingBrowserEvent options.
Returns IncomingBrowserEvent
A new instance of IncomingBrowserEvent.

Overrides IncomingEvent.create

Events

`Static` `Readonly`INCOMING_EVENT

INCOMING_EVENT: string

INCOMING_EVENT Event name, fires on platform message.

IncomingEvent#INCOMING_EVENT

Class IncomingBrowserEvent

Author

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Events

Constructors

Protectedconstructor

Parameters

Returns IncomingBrowserEvent

Throws

Properties

Readonlycookies

Readonlylocale

Readonlymetadata

Readonlymethod

Readonlyprotocol

Readonlyquery

Optional ReadonlyqueryString

Protected OptionalrouteResolver

Readonlysource

ReadonlytimeStamp

Readonlytype

Readonlyurl

Protected OptionaluserResolver

Static ReadonlyINCOMING_BROWSER_EVENT

Accessors

decodedPathname

Returns string

hash

Returns string

host

Returns string

hostname

Returns string

isSecure

Returns boolean

params

Returns Record<string, unknown>

path

Returns string

pathname

Returns string

platform

Returns string | symbol

scheme

Returns string

segments

Returns string[]

uri

Returns string

userAgent

Returns string

Methods

clone

Returns this

fingerprint

Returns string

get

Type Parameters

Parameters

Returns TReturn

Type Parameters

Parameters

Returns TReturn

getCookie

Type Parameters

Parameters

Returns TReturn

Type Parameters

Parameters

Returns TReturn

getMetadataValue

Type Parameters

Parameters

Returns TReturn

Type Parameters

`Protected`constructor

`Readonly`cookies

`Readonly`locale

`Readonly`metadata

`Readonly`method

`Readonly`protocol

`Readonly`query

`Optional` `Readonly`queryString

`Protected` `Optional`routeResolver

`Readonly`source

`Readonly`timeStamp

`Readonly`type

`Readonly`url

`Protected` `Optional`userResolver

`Static` `Readonly`INCOMING_BROWSER_EVENT

`Static`create

`Static` `Readonly`INCOMING_EVENT