Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Better typings #158

Merged
merged 3 commits into from
Feb 26, 2018
Merged

Better typings #158

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
2caebaf
Allow mock users to override base class for the mock Request/Response…
Feb 22, 2018
54344b2
[fix] add missing _getRenderView method and support custom properties…
Feb 23, 2018
455e944
[improve] support custom properties on Request objects
Feb 23, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
23 changes: 15 additions & 8 deletions lib/index.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -47,9 +47,12 @@ declare module 'node-mocks-http' {
body?: Body;
query?: Query;
files?: Files;

// Support custom properties appended on Request objects.
[key: string]: any;
}

export interface MockRequest extends Request {
export type MockRequest<T extends Request> = T & {
_setParameter: (key: string, value: string) => void;
_setSessionVariable: (variable: string, value: string) => void;
_setCookiesVariable: (variable: string, value: string) => void;
Expand All @@ -61,6 +64,9 @@ declare module 'node-mocks-http' {
_setOriginalUrl: (value: string) => void;
_setBody: (body: Body) => void;
_addBody: (key: string, value: any) => void;

// Support custom properties appended on Request objects.
[key: string]: any;
}

export interface ResponseOptions {
Expand All @@ -69,7 +75,7 @@ declare module 'node-mocks-http' {
req?: any;
}

export interface MockResponse extends Response {
export type MockResponse<T extends Response> = T & {
_isEndCalled: () => boolean;
_getHeaders: () => Headers;
_getData: () => any;
Expand All @@ -80,16 +86,17 @@ declare module 'node-mocks-http' {
_isDataLengthValid: () => boolean;
_getRedirectUrl: () => string;
_getRenderData: () => any;
_getRenderView: () => string;
}

export function createRequest(options?: RequestOptions): MockRequest;
export function createRequest<T extends Request = Request>(options?: RequestOptions): MockRequest<T>;

export function createResponse(options?: ResponseOptions): MockResponse;
export function createResponse<T extends Response = Response>(options?: ResponseOptions): MockResponse<T>;

export interface Mocks {
req: MockRequest;
res: MockResponse;
export interface Mocks<T1 extends Request, T2 extends Response> {
req: MockRequest<T1>;
res: MockResponse<T2>;
}

export function createMocks(reqOptions?: RequestOptions, resOptions?: ResponseOptions): Mocks;
export function createMocks<T1 extends Request = Request, T2 extends Response = Response>(reqOptions?: RequestOptions, resOptions?: ResponseOptions): Mocks<T1, T2>;
}