request-mocking-protocol
Version:
A protocol for declarative mocking of HTTP requests
30 lines • 1.5 kB
TypeScript
/**
* MockClient class.
*/
import { MockRequestSchema, MockRequestSchemaInit, MockResponseSchemaInit, MockSchema } from '../protocol';
export type MockClientOptions = {
debug?: boolean;
defaultMethod?: MockRequestSchema['method'];
};
export type MockRequestSchemaNoMethod = Omit<MockRequestSchemaInit, 'method'>;
export declare class MockClient {
protected options?: MockClientOptions | undefined;
private mockSchemas;
headers: Record<string, string>;
onChange?: (headers: Record<string, string>) => unknown;
constructor(options?: MockClientOptions | undefined);
get schemas(): MockSchema[];
addMock(reqSchema: MockRequestSchemaInit, resSchema: MockResponseSchemaInit): Promise<void>;
GET(reqSchema: MockRequestSchemaNoMethod, resSchema: MockResponseSchemaInit): Promise<void>;
POST(reqSchema: MockRequestSchemaNoMethod, resSchema: MockResponseSchemaInit): Promise<void>;
PUT(reqSchema: MockRequestSchemaNoMethod, resSchema: MockResponseSchemaInit): Promise<void>;
DELETE(reqSchema: MockRequestSchemaNoMethod, resSchema: MockResponseSchemaInit): Promise<void>;
HEAD(reqSchema: MockRequestSchemaNoMethod, resSchema: MockResponseSchemaInit): Promise<void>;
ALL(reqSchema: MockRequestSchemaNoMethod, resSchema: MockResponseSchemaInit): Promise<void>;
reset(): Promise<void>;
private addMockWithMethod;
private rebuildHeaders;
private buildRequestSchema;
private buildResponseSchema;
}
//# sourceMappingURL=index.d.ts.map