Skip to content

feat: type _getJSONData method #324

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

Merged
eugef merged 1 commit into from
Nov 4, 2025
Merged

feat: type _getJSONData method #324

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
17 changes: 13 additions & 4 deletions lib/http-mock.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import { Request, Response, CookieOptions } from 'express';
import { IncomingMessage, OutgoingMessage } from 'http';

export type RequestType = IncomingMessage | globalThis.Request;
export type ResponseType = OutgoingMessage | globalThis.Response;
export type ResponseType<ResBody = any> = OutgoingMessage | globalThis.Response | Response<ResBody>;

export type RequestMethod = 'CONNECT' | 'DELETE' | 'GET' | 'HEAD' | 'OPTIONS' | 'PATCH' | 'POST' | 'PUT' | 'TRACE';

Expand Down Expand Up @@ -170,7 +170,7 @@ export type MockResponse<T extends ResponseType> = T & {
_isEndCalled: () => boolean;
_getHeaders: () => HeaderWebAPI;
_getData: () => any;
_getJSONData: () => any;
_getJSONData: () => T extends Response<infer ResBody> ? ResBody : any;
_getBuffer: () => Buffer;
_getLocals: () => any;
_getStatusCode: () => number;
Expand All @@ -187,7 +187,9 @@ export type MockResponse<T extends ResponseType> = T & {

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

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

export interface Mocks<T1 extends RequestType, T2 extends ResponseType> {
req: MockRequest<T1>;
Expand All @@ -197,4 +199,11 @@ export interface Mocks<T1 extends RequestType, T2 extends ResponseType> {
export function createMocks<T1 extends RequestType = Request, T2 extends ResponseType = Response>(
reqOptions?: RequestOptions,
resOptions?: ResponseOptions
): Mocks<T1, T2>;
): Mocks<
T1,
T2 extends globalThis.Response
? globalThis.Response
: T2 extends Response<infer ResBody>
? Response<ResBody>
: Response
>;
8 changes: 8 additions & 0 deletions test/lib/http-mock.test-d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,14 @@ expectNotType<MockResponse<ExpressResponse>>(createResponse<NodeResponse>());
expectAssignable<NodeResponse>(createResponse<NodeResponse>());
expectNotAssignable<ExpressResponse>(createResponse<NodeResponse>());

expectType<MockResponse<ExpressResponse<{ message: number }>>>(createResponse<ExpressResponse<{ message: number }>>());
expectNotType<MockResponse<NodeResponse>>(createResponse<ExpressResponse<{ message: number }>>());
expectAssignable<NodeResponse>(createResponse<ExpressResponse<{ message: number }>>());

expectType<Mocks<ExpressRequest, ExpressResponse>>(createMocks());
// eslint-disable-next-line no-undef
expectType<Mocks<globalThis.Request, globalThis.Response>>(createMocks<globalThis.Request, globalThis.Response>());

expectType<Mocks<ExpressRequest, ExpressResponse<{ message: number }>>>(
createMocks<ExpressRequest, ExpressResponse<{ message: number }>>()
);