• mockttp
• Mockttp

Interface Mockttp

interface Mockttp {
    port: number;
    proxyEnv: ProxyEnvConfig;
    url: string;
    addRequestRule(ruleData: RequestRuleData): Promise<MockedEndpoint>;
    addRequestRules(...ruleData: RequestRuleData[]): Promise<MockedEndpoint[]>;
    addWebSocketRule(ruleData: WebSocketRuleData): Promise<MockedEndpoint>;
    addWebSocketRules(...ruleData: WebSocketRuleData[]): Promise<MockedEndpoint[]>;
    enableDebug(): void;
    forAnyRequest(): RequestRuleBuilder;
    forAnyWebSocket(url?: string | RegExp): WebSocketRuleBuilder;
    forDelete(url?: string | RegExp): RequestRuleBuilder;
    forGet(url?: string | RegExp): RequestRuleBuilder;
    forHead(url?: string | RegExp): RequestRuleBuilder;
    forJsonRpcRequest(match?: {
        method?: string;
        params?: any;
    }): RequestRuleBuilder;
    forOptions(url?: string | RegExp): RequestRuleBuilder;
    forPatch(url?: string | RegExp): RequestRuleBuilder;
    forPost(url?: string | RegExp): RequestRuleBuilder;
    forPut(url?: string | RegExp): RequestRuleBuilder;
    forUnmatchedRequest(): RequestRuleBuilder;
    getMockedEndpoints(): Promise<MockedEndpoint[]>;
    getPendingEndpoints(): Promise<MockedEndpoint[]>;
    getRuleParameterKeys(): Promise<string[]>;
    on(event: "request-initiated", callback: ((req: Request) => void)): Promise<void>;
    on(event: "request-body-data", callback: ((req: BodyData) => void)): Promise<void>;
    on(event: "request", callback: ((req: CompletedRequest) => void)): Promise<void>;
    on(event: "response-initiated", callback: ((req: InitiatedResponse) => void)): Promise<void>;
    on(event: "response-body-data", callback: ((req: BodyData) => void)): Promise<void>;
    on(event: "response", callback: ((req: CompletedResponse) => void)): Promise<void>;
    on(event: "websocket-request", callback: ((req: CompletedRequest) => void)): Promise<void>;
    on(event: "websocket-accepted", callback: ((req: CompletedResponse) => void)): Promise<void>;
    on(event: "websocket-message-received", callback: ((req: WebSocketMessage) => void)): Promise<void>;
    on(event: "websocket-message-sent", callback: ((req: WebSocketMessage) => void)): Promise<void>;
    on(event: "websocket-close", callback: ((req: WebSocketClose) => void)): Promise<void>;
    on(event: "abort", callback: ((req: AbortedRequest) => void)): Promise<void>;
    on(event: "tls-passthrough-opened", callback: ((req: TlsPassthroughEvent) => void)): Promise<void>;
    on(event: "tls-passthrough-closed", callback: ((req: TlsPassthroughEvent) => void)): Promise<void>;
    on(event: "tls-client-error", callback: ((req: TlsHandshakeFailure) => void)): Promise<void>;
    on(event: "client-error", callback: ((error: ClientError) => void)): Promise<void>;
    on(event: "raw-passthrough-opened", callback: ((req: RawPassthroughEvent) => void)): Promise<void>;
    on(event: "raw-passthrough-closed", callback: ((req: RawPassthroughEvent) => void)): Promise<void>;
    on(event: "raw-passthrough-data", callback: ((req: RawPassthroughDataEvent) => void)): Promise<void>;
    on<T>(event: "rule-event", callback: ((event: RuleEvent<T>) => void)): Promise<void>;
    reset(): void;
    setRequestRules(...ruleData: RequestRuleData[]): Promise<MockedEndpoint[]>;
    setWebSocketRules(...ruleData: WebSocketRuleData[]): Promise<MockedEndpoint[]>;
    start(port?: number | PortRange): Promise<void>;
    stop(): Promise<void>;
    urlFor(path: string): string;
}