ProtectedconstructorThe options to create an IncomingHttpEvent instance.
Protected Readonly_The headers of the request.
ReadonlyacceptsThe content negotiation handler for the request.
ReadonlybodyThe body of the request.
ReadonlycookiesThe cookies included in the request.
ReadonlyfilesThe files included in the request.
ReadonlyipThe IP address of the client making the request.
ReadonlyipsThe list of IP addresses, typically for proxies.
ReadonlylocaleThe locale of the event.
ReadonlymetadataThe metadata associated with the event.
ReadonlymethodThe HTTP method of the request.
ReadonlyprotocolThe protocol used for the request (e.g., http or https).
ReadonlyqueryThe query parameters of the request.
Optional ReadonlyqueryThe query string of the request.
Protected OptionalrouteReadonlysourceThe source of the event.
ReadonlytimeThe timestamp of the event creation.
ReadonlytypeThe type of the event.
ReadonlyurlThe URL of the request.
Protected OptionaluserStatic ReadonlyINCOMING_The charset specified in the content-type header.
An array of acceptable character sets for the request.
The content type specified in the headers.
The decoded pathname of the URL.
An array of acceptable encodings for the request.
The ETag of the request, if present.
The hash part of the URL.
The headers of the request.
The host of the URL (hostname:port).
The hostname of the URL.
Whether the request is an AJAX request.
Whether the request was prefetch.
Whether the request was made over a secure connection.
Whether the request is an XMLHttpRequest.
An array of acceptable languages for the request.
The route parameters.
The full path including pathname and search query.
The pathname of the URL.
Get the platform of the event source.
The platform of the event source.
The protocol of the URL (e.g., "http" or "https").
The URL segments split by '/'.
An array of acceptable content types for the request.
The full URL as a string.
The user agent of the request.
Return the first accepted charset.
The charsets to check.
The first accepted charset, or false if none are accepted.
Return the first accepted encoding.
The encodings to check.
The first accepted encoding, or false if none are accepted.
Return the first accepted language.
The languages to check.
The first accepted language, or false if none are accepted.
Return the first accepted content type.
The content types to check.
The first accepted type, or false if none are accepted.
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.
A cloned instance of the current class.
Filter and return files based on their names.
The array of file names to filter.
An object containing the filtered files.
Generate a unique fingerprint for the event.
Optionalfull: boolean
Whether to include the user agent and IP address in the fingerprint.
The generated fingerprint as a base64 string.
Get request DATA by key with a fallback (route params → body → query → metadata).
SECURITY: does NOT read headers or cookies — use getHeader/getCookie.
The key to look for.
A fallback value if the key is not found.
The value of the key or the fallback.
Get the body of the request.
The body of the request or the fallback.
Get a cookie value.
The cookie name.
The cookie value or the fallback.
Get a file by its name.
The name of the file.
The file if it exists, otherwise undefined.
Get file extension for a given MIME type.
The MIME type.
The corresponding file extension, or undefined if not found.
Get a header value.
The header name.
The header value or the fallback value.
Get data from metadata.
The key to retrieve from metadata.
The value associated with the key or the fallback.
Get MIME type for a given file path or extension.
The file path or extension.
The corresponding MIME type, or undefined if not found.
Retrieve a parameter from the route if it exists.
The name of the parameter to retrieve.
The value of the parameter if it exists, otherwise undefined.
Get the URI with or without the domain.
Whether to include the domain in the URI.
The URI with or without the domain.
Get the user instance.
The user object, resolved through a user resolver function if available.
Get the user resolver function.
The user resolver function.
Check if a cookie exists.
The cookie name to check.
True if the cookie exists, otherwise false.
Check if a file exists by its name.
The name of the file.
True if the file exists, otherwise false.
Check if a header exists.
The header name to check.
True if the header exists, otherwise false.
Check if a key exists in the JSON body.
The key to check for.
True if the key exists, otherwise false.
Check if the given value is equal to the specified value.
The key to check.
The value to compare against.
True if the key's value is equal to the specified value, false otherwise.
Determine if the response cache is fresh.
The outgoing HTTP response to check freshness against.
True if the cache is fresh, otherwise false.
Check if the current event method matches the given method.
The method to check.
True if the event method matches, otherwise false.
Check if the current event method is cacheable.
True if the method is cacheable, otherwise false.
Check if the current event method is considered safe.
True if the method is safe, otherwise false.
Check if the event source is from a platform.
The platform to check.
True if the event source is from the platform, false otherwise.
Determine if the response cache is stale.
The outgoing HTTP response to check staleness against.
True if the cache is stale, otherwise false.
Check if the request matches one of the given content types.
The content types to check.
The best match, or false if no match is found.
Get a value from the JSON body.
The key to look for in the JSON body.
The value of the key or the fallback.
Determines the preferred response type based on content negotiation. Uses Accept, Content-Type, User-Agent, and AJAX detection.
Allowed response types, in priority order.
Default type if none match.
The best response type as a string.
Get request range.
The maximum size of the resource.
Specifies if overlapping & adjacent ranges should be combined.
The parsed range, or undefined if not applicable.
Add data to metadata.
The key or object to add to metadata.
Optionalvalue: unknown
The value to associate with the key.
This Event instance.
Set the user resolver function.
The user resolver function.
The current instance for method chaining.
Generate a full URL for the given path.
The path to append to the base URL.
The full URL for the given path.
StaticcreateCreate an IncomingHttpEvent.
The IncomingHttpEvent options.
A new instance of IncomingHttpEvent.
Constructor for IncomingHttpEvent.