wiremock-captain/dist/types/externalTypes.d.ts

A better way to use the WireMock simulator to test your HTTP APIs

import { KeyValue, Method, WebhookBody } from './internalTypes';
export interface IWireMockScenario {
    scenarioName: string;
    requiredScenarioState: 'Started' | string;
    newScenarioState?: string;
}
export interface IChunkedDribbleDelay {
    type: DelayType.CHUNKED_DRIBBLE;
    numberOfChunks: number;
    totalDuration: number;
}
export interface IFixedDelay {
    type: DelayType.FIXED;
    constantDelay: number;
}
export interface ILogNormalDelay {
    type: DelayType.LOG_NORMAL;
    median: number;
    sigma: number;
}
export interface IUniformDelay {
    type: DelayType.UNIFORM;
    lower: number;
    upper: number;
}
export interface IWireMockWebhook {
    method: Method;
    url: string;
    headers?: Record<string, KeyValue>;
    body?: WebhookBody;
    delay?: WireMockDelay;
}
export declare enum BodyType {
    Default = "jsonBody",
    Body = "body",
    Base64Body = "base64Body"
}
export declare enum DelayType {
    CHUNKED_DRIBBLE = "CHUNKED_DRIBBLE",
    FIXED = "FIXED",
    LOG_NORMAL = "LOG_NORMAL",
    UNIFORM = "UNIFORM"
}
export declare enum EndpointFeature {
    Default = "url",
    UrlPath = "urlPath",
    UrlPathPattern = "urlPathPattern",
    UrlPattern = "urlPattern"
}
export declare enum MatchingAttributes {
    BinaryEqualTo = "binaryEqualTo",
    Contains = "contains",
    DoesNotMatch = "doesNotMatch",
    EqualTo = "equalTo",
    EqualToJson = "equalToJson",
    EqualToXml = "equalToXml",
    Matches = "matches",
    MatchesJsonPath = "matchesJsonPath"
}
export declare enum WireMockFault {
    CONNECTION_RESET_BY_PEER = "CONNECTION_RESET_BY_PEER",
    EMPTY_RESPONSE = "EMPTY_RESPONSE",
    MALFORMED_RESPONSE_CHUNK = "MALFORMED_RESPONSE_CHUNK",
    RANDOM_DATA_THEN_CLOSE = "RANDOM_DATA_THEN_CLOSE"
}
export declare enum ResponseTransformer {
    RESPONSE_TEMPLATE = "response-template"
}
export { Method };
export type WireMockDelay = IChunkedDribbleDelay | IFixedDelay | ILogNormalDelay | IUniformDelay;