An HttpResponse is valid until either onAborted callback or any of the .end/.tryEnd calls succeed. You may attach user data to this object.

interface HttpResponse {
    close(): HttpResponse;
    cork(cb): HttpResponse;
    end(body?, closeConnection?): HttpResponse;
    endWithoutBody(reportedContentLength?, closeConnection?): HttpResponse;
    getProxiedRemoteAddress(): ArrayBuffer;
    getProxiedRemoteAddressAsText(): ArrayBuffer;
    getRemoteAddress(): ArrayBuffer;
    getRemoteAddressAsText(): ArrayBuffer;
    getWriteOffset(): number;
    onAborted(handler): HttpResponse;
    onData(handler): HttpResponse;
    onWritable(handler): HttpResponse;
    pause(): void;
    resume(): void;
    tryEnd(fullBodyOrChunk, totalSize): [boolean, boolean];
    upgrade<UserData>(userData, secWebSocketKey, secWebSocketProtocol, secWebSocketExtensions, context): void;
    write(chunk): boolean;
    writeHeader(key, value): HttpResponse;
    writeStatus(status): HttpResponse;
    [key: string]: any;
}

Indexable

[key: string]: any

Arbitrary user data may be attached to this object

Methods

  • Corking a response is a performance improvement in both CPU and network, as you ready the IO system for writing multiple chunks at once. By default, you're corked in the immediately executing top portion of the route handler. In all other cases, such as when returning from await, or when being called back from an async database request or anything that isn't directly executing in the route handler, you'll want to cork before calling writeStatus, writeHeader or just write. Corking takes a callback in which you execute the writeHeader, writeStatus and such calls, in one atomic IO operation. This is important, not only for TCP but definitely for TLS where each write would otherwise result in one TLS block being sent off, each with one send syscall.

    Example usage:

    res.cork(() => {
    res.writeStatus("200 OK").writeHeader("Some", "Value").write("Hello world!");
    });

    Parameters

    • cb: (() => void)
        • (): void
        • Returns void

    Returns HttpResponse

  • Ends this response without a body.

    Parameters

    • Optional reportedContentLength: number
    • Optional closeConnection: boolean

    Returns HttpResponse

  • Returns the remote IP address in binary format (4 or 16 bytes), as reported by the PROXY Protocol v2 compatible proxy.

    Returns ArrayBuffer

  • Returns the remote IP address as text, as reported by the PROXY Protocol v2 compatible proxy.

    Returns ArrayBuffer

  • Returns the remote IP address in binary format (4 or 16 bytes).

    Returns ArrayBuffer

  • Returns the remote IP address as text.

    Returns ArrayBuffer

  • Returns the global byte write offset for this response. Use with onWritable.

    Returns number

  • Every HttpResponse MUST have an attached abort handler IF you do not respond to it immediately inside of the callback. Returning from an Http request handler without attaching (by calling onAborted) an abort handler is ill-use and will terminate. When this event emits, the response has been aborted and may not be used.

    Parameters

    • handler: (() => void)
        • (): void
        • Returns void

    Returns HttpResponse

  • Handler for reading data from POST and such requests. You MUST copy the data of chunk if isLast is not true. We Neuter ArrayBuffers on return, making it zero length.

    Parameters

    • handler: ((chunk, isLast) => void)
        • (chunk, isLast): void
        • Parameters

          • chunk: ArrayBuffer
          • isLast: boolean

          Returns void

    Returns HttpResponse

  • Registers a handler for writable events. Continue failed write attempts in here. You MUST return true for success, false for failure. Writing nothing is always success, so by default you must return true.

    Parameters

    • handler: ((offset) => boolean)
        • (offset): boolean
        • Parameters

          • offset: number

          Returns boolean

    Returns HttpResponse

  • Pause http body streaming (throttle)

    Returns void

  • Resume http body streaming (unthrottle)

    Returns void

  • Ends this response, or tries to, by streaming appropriately sized chunks of body. Use in conjunction with onWritable. Returns tuple [ok, hasResponded].

    Parameters

    Returns [boolean, boolean]

  • Enters or continues chunked encoding mode. Writes part of the response. End with zero length write. Returns true if no backpressure was added.

    Parameters

    Returns boolean

Generated using TypeDoc