HttpServerResponse <CTX>

Hierarchy

• ServerResponse<CTX>
  • HttpServerResponse

Index

Constructors

• constructor

Methods

• blob
• fail
• file
• header
• headers
• html
• json
• redirect
• sse
• status
• stream
• success
• text
• BLOB_TPL
• FILE_TPL
• HTML_TPL
• JSON_TPL
• SSE_TPL
• STREAM_TPL
• TEXT_TPL

Constructors

constructor

• new HttpServerResponse<CTX>(ctx: CTX): HttpServerResponse<CTX>

• Overrides ServerResponse.constructor

  Type parameters

  • CTX: Context

Methods

blob

• blob(data: Buffer, mimeType?: string): any

• Overrides ServerResponse.blob

fail

• fail(): HttpServerResponse<CTX>

• Inherited from ServerResponse.fail

file

• file(filePath: string, mimeType?: string): any

header

• header(key: string, value: string): HttpServerResponse<CTX>

headers

• headers(headers: Record<string, string>): HttpServerResponse<CTX>

html

• html(data: string): any

json

• json(data: Record<any, any>): any

• Overrides ServerResponse.json

redirect

• redirect(url: string, status?: number): any

sse

• sse(options?: ServerSendEventStreamOptions<CTX>): ServerSendEventStream<Context>

status

• status(code: number): HttpServerResponse<CTX>

stream

• stream(options?: ServerStreamOptions<CTX>): HttpStreamResponse<Context>

success

• success(): HttpServerResponse<CTX>

• Inherited from ServerResponse.success

text

• text(data: string): any

• Overrides ServerResponse.text

staticBLOB_TPL

• BLOB_TPL<CTX>(data: Buffer, isSuccess: boolean, ctx: CTX): unknown

• Inherited from ServerResponse.BLOB_TPL

  Type parameters

  • CTX: Context

staticFILE_TPL

• FILE_TPL<CTX>(data: Readable, isSuccess: boolean, ctx: CTX): Readable

• Type parameters

  • CTX: Context

staticHTML_TPL

• HTML_TPL<CTX>(data: string, isSuccess: boolean, ctx: CTX): unknown

• Type parameters

  • CTX: Context

staticJSON_TPL

• JSON_TPL<CTX>(data: Record<any, any>, isSuccess: boolean, ctx: CTX): unknown

• Inherited from ServerResponse.JSON_TPL

  Type parameters

  • CTX: Context

staticSSE_TPL

• SSE_TPL<CTX>(data: ServerSendEventMessage, ctx: CTX): ServerSendEventMessage

• Type parameters

  • CTX: Context

staticSTREAM_TPL

• STREAM_TPL<CTX>(data: unknown, ctx: CTX): unknown

• Type parameters

  • CTX: Context

staticTEXT_TPL

• TEXT_TPL<CTX>(data: string, isSuccess: boolean, ctx: CTX): unknown

• Inherited from ServerResponse.TEXT_TPL

  Type parameters

  • CTX: Context