Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface HttpResponse

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

Hierarchy

  • HttpResponse

Indexable

[key: string]: any

Arbitrary user data may be attached to this object

Index

Methods

close

cork

  • cork(cb: function): void
  • 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: function
        • (): void
        • Returns void

    Returns void

end

getRemoteAddress

  • getRemoteAddress(): ArrayBuffer
  • Returns the remote IP address

    Returns ArrayBuffer

getWriteOffset

  • getWriteOffset(): number
  • Returns the global byte write offset for this response. Use with onWritable.

    Returns number

onAborted

  • 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 termiante. When this event emits, the response has been aborted and may not be used.

    Parameters

    • handler: function
        • (): void
        • Returns void

    Returns HttpResponse

onData

  • 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: function
        • (chunk: ArrayBuffer, isLast: boolean): void
        • Parameters

          • chunk: ArrayBuffer
          • isLast: boolean

          Returns void

    Returns HttpResponse

onWritable

  • 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: function
        • (offset: number): boolean
        • Parameters

          • offset: number

          Returns boolean

    Returns HttpResponse

tryEnd

  • tryEnd(fullBodyOrChunk: RecognizedString, totalSize: number): [boolean, boolean]
  • 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]

write

writeHeader

writeStatus

Generated using TypeDoc