UNPKG

1.46 kBTypeScriptView Raw
1/// <reference types="node" />
2import { StatusCode } from './StatusCode';
3import { ResponseData } from './ResponseData';
4import { StormError, IErrorResponse } from './StormError';
5import * as express from 'express';
6export declare type SendableData = ResponseData | Error | IErrorResponse | any;
7export interface IHeaderKeyValuePair {
8 [key: string]: string;
9}
10export declare class Response<TResponse = SendableData, TErrorResponse = Error | IErrorResponse | string> {
11 private response;
12 private created;
13 private requestURL;
14 constructor(response: express.Response, requestURL: string);
15 setStatus(status: StatusCode): Response<TResponse, TErrorResponse>;
16 getStatus(): StatusCode;
17 redirect(url: string): void;
18 send(data?: TResponse | TErrorResponse | StormError | IErrorResponse): void;
19 pipe(stream: NodeJS.ReadableStream): void;
20 success(data?: TResponse): void;
21 setHeader(key: string, value: string): void;
22 setHeaders(keyValuePair: IHeaderKeyValuePair): void;
23 isHeadersSent(): boolean;
24 error(error?: TErrorResponse | ResponseData<TErrorResponse>): void;
25 badRequest(data?: TErrorResponse | StormError): void;
26 unauthorized(data?: TErrorResponse | StormError): void;
27 forbidden(data?: TErrorResponse | StormError): void;
28 conflict(data?: TErrorResponse | StormError): void;
29 notFound(data?: TErrorResponse | StormError): void;
30 internalError(data?: TErrorResponse | StormError): void;
31}