Class Response<TResponse, TErrorResponse>

Type Parameters

TResponse = SendableData
TErrorResponse = Error | IErrorResponse | string

Index

Constructors

Methods

error getStatus isHeadersSent pipe redirect send setHeader setHeaders setStatus success

Constructors

constructor

new Response<TResponse = any, TErrorResponse = string | Error | IErrorResponse>(
response: Response,
requestURL: string,
): Response<TResponse, TErrorResponse>
Type Parameters
- TResponse = any
- TErrorResponse = string | Error | IErrorResponse
Parameters
- response: Response
- requestURL: string
Returns Response<TResponse, TErrorResponse>
- Defined in src/Response.ts:38

Methods

error

error(error?: TErrorResponse | ResponseData<TErrorResponse>): void
Parameters
- Optionalerror: TErrorResponse | ResponseData<TErrorResponse>
Returns void
- Defined in src/Response.ts:131

getStatus

getStatus(): StatusCode
Returns StatusCode
- Defined in src/Response.ts:49

isHeadersSent

isHeadersSent(): boolean
Returns boolean
- Defined in src/Response.ts:127

pipe

pipe(stream: ReadableStream): void
Parameters
- stream: ReadableStream
Returns void
- Defined in src/Response.ts:100

redirect

redirect(url: string): void
Parameters
- url: string
Returns void
- Defined in src/Response.ts:53

send

send(
    data?:
        | Buffer<ArrayBufferLike>
        | IErrorResponse
        | StormError<any>
        | TResponse
        | TErrorResponse,
): void
Parameters
- Optionaldata:
      | Buffer<ArrayBufferLike>
      | IErrorResponse
      | StormError<any>
      | TResponse
      | TErrorResponse
Returns void
- Defined in src/Response.ts:95

setHeader

setHeader(key: string, value: string): void
Parameters
- key: string
- value: string
Returns void
- Defined in src/Response.ts:119

setHeaders

setHeaders(keyValuePair: IHeaderKeyValuePair): void
Parameters
- keyValuePair: IHeaderKeyValuePair
Returns void
- Defined in src/Response.ts:123

setStatus

setStatus(status: StatusCode): Response<TResponse, TErrorResponse>
Parameters
- status: StatusCode
Returns Response<TResponse, TErrorResponse>
- Defined in src/Response.ts:44

success

success(data?: TResponse): void
Parameters
- Optionaldata: TResponse
Returns void
- Defined in src/Response.ts:108