Type Alias IHttpRes

Type declaration

• appendHeader:function

  • appendHeader(key: string, value: string): IHttpRes

  • Appends a value to an existing response header instead of overwriting it.

    Useful for headers that support multiple values (e.g. Vary, Link, Set-Cookie). Unlike setHeader, this adds the value alongside any existing ones rather than replacing them.

    Parameters

    • key: string

      The header name.
    • value: string

      The header value to append.

    Returns IHttpRes

• buildWebRes:function

  • buildWebRes(): Response

  • Builds and returns the final Web API Response object from all configured headers, status, cookies, and body.

    You typically don't need to call this in handler functions — the HttpRouter class calls it automatically. Use it directly only in isolation, such as during testing.

    Returns Response

    The constructed HTTP response.

• getHeader:function

  • getHeader(key: string): null | string

  • Returns the current value of a response header, or an empty string if not set.

    Parameters

    • key: string

      The header name.

    Returns null | string

    The header value, or null if absent.

• hasCookies:function

  • hasCookies(name?: string): boolean

  • Checks whether any Set-Cookie headers are present, or whether a header with the given name exists when one is provided.

    Parameters

    • Optionalname: string

      Optional. The name of the cookie to check. When omitted, returns true if at least one Set-Cookie header exists.

    Returns boolean

    true if a matching or any Set-Cookie header is present.

• putCookie:function

  • putCookie(name: string, value: string, settings?: CookieSetSettings): IHttpRes

  • Adds a Set-Cookie header if one does not exist, or updates it if a header with the given name is already present.

    Parameters

    • name: string

      The name of the cookie.
    • value: string

      The cookie value.
    • Optionalsettings: CookieSetSettings

      Optional cookie attributes (expires, httpOnly, etc.).

    Returns IHttpRes

    This instance for chaining.

• removeCookie:function

  • removeCookie(name: string, settings?: CookieScope): IHttpRes

  • Adds or updates a Set-Cookie header with Max-Age=0 for the given name, expiring the cookie when the response is sent.

    If a Set-Cookie header with the given name already exists, it is replaced with an expired version. Otherwise an expired header is appended to ensure the client removes any matching cookie.

    Parameters

    • name: string

      The name of the cookie to expire.
    • Optionalsettings: CookieScope

      Optional scope attributes (path, secure, domain) to match the cookie that was originally set.

    Returns IHttpRes

    This instance for chaining.

• setBody:function

  • setBody(
        content:
            | string
            | ArrayBuffer
            | Uint8Array<ArrayBufferLike>
            | AsyncIterable<unknown, any, any>,
    ): IHttpRes

  • Sets the response body as raw bytes without overriding the Content-Type header.

    Accepts a string, binary buffer, or an async iterable of byte chunks for streaming. Useful when the caller wants full control over the Content-Type header.

    Parameters

    • content:
          | string
          | ArrayBuffer
          | Uint8Array<ArrayBufferLike>
          | AsyncIterable<unknown, any, any>

      The response body content.

    Returns IHttpRes

• setCacheControl:function

  • setCacheControl(cacheControl: HttpResCacheControl): IHttpRes

  • Sets the Cache-Control header with caching directives.

    Parameters

    • cacheControl: HttpResCacheControl

    Returns IHttpRes

• setContentDisposition:function

  • setContentDisposition(disposition: HttpResContentDisposition): IHttpRes

  • Sets the Content-Disposition header (inline or attachment).

    Parameters

    • disposition: HttpResContentDisposition

    Returns IHttpRes

• setContentEncoding:function

  • setContentEncoding(encoding: HttpResContentEncoding): IHttpRes

  • Sets the Content-Encoding header (e.g. gzip, br, deflate).

    Parameters

    • encoding: HttpResContentEncoding

    Returns IHttpRes

• setContentLanguage:function

  • setContentLanguage(language: HttpResContentLanguage): IHttpRes

  • Sets the Content-Language header to a BCP 47 language tag.

    Parameters

    • language: HttpResContentLanguage

    Returns IHttpRes

• setContentLength:function

  • setContentLength(length: number | IFileSize): IHttpRes

  • Sets the Content-Length header, accepting either a raw number or an IFileSize value.

    Parameters

    • length: number | IFileSize

    Returns IHttpRes

• setContentRange:function

  • setContentRange(range: `${string} ${string}/${string}`): IHttpRes

  • Sets the Content-Range header for partial content responses.

    Parameters

    • range: `${string} ${string}/${string}`

    Returns IHttpRes

• setContentType:function

  • setContentType(type: HttpResContentType): IHttpRes

  • Sets the Content-Type header to a well-known media type.

    Parameters

    • type: HttpResContentType

    Returns IHttpRes

• setETag:function

  • setETag(eTag: HttpResETag): IHttpRes

  • Sets the ETag header for conditional response caching.

    Parameters

    • eTag: HttpResETag

    Returns IHttpRes

• setHeader:function

  • setHeader(key: string, value: string): IHttpRes

  • Sets an arbitrary response header by key and value.

    Useful for headers that don't have a dedicated setter method, such as custom headers or less common standard headers.

    Parameters

    • key: string

      The header name (e.g. "X-Custom-Header").
    • value: string

      The header value.

    Returns IHttpRes

• setLocation:function

  • setLocation(location: string): IHttpRes

  • Sets the Location header, typically used for redirects (3xx).

    Parameters

    • location: string

    Returns IHttpRes

• setStatus:function

  • setStatus(status: number | HttpStatus): IHttpRes

  • Sets the HTTP response status code or well-known HttpStatus.

    Parameters

    • status: number | HttpStatus

    Returns IHttpRes

• setStatusText:function

  • setStatusText(statusText: string): IHttpRes

  • Sets the HTTP response status text (the human-readable reason phrase).

    Parameters

    • statusText: string

      The status text (e.g. "Not Found").

    Returns IHttpRes

• withoutCookies:function

  • withoutCookies(name?: string): IHttpRes

  • Strips all Set-Cookie headers from the response builder, or only the header matching the given name when one is provided.

    Parameters

    • Optionalname: string

      Optional. The name of the cookie to strip. When omitted, all Set-Cookie headers are removed.

    Returns IHttpRes

    This instance for chaining.