mockttp
    Preparing search index...

    Interface WebSocketRule

    interface WebSocketRule {
        id: string;
        priority: number;
        requestCount: number;
        requests: Promise<CompletedRequest>[];
        dispose(): void;
        explain(withoutExactCompletion?: boolean): string;
        handle(
            request: OngoingRequest,
            response: Socket,
            head: Buffer,
            options: {
                debug: boolean;
                emitEventCallback?: (type: string, event: unknown) => void;
                keyLogStream?: Writable;
                record: boolean;
            },
        ): Promise<void>;
        handle(
            req: OngoingRequest,
            res: Socket,
            head: Buffer,
            options: {
                debug: boolean;
                emitEventCallback?: (type: string, event: unknown) => void;
                keyLogStream?: Writable;
                record: boolean;
            },
        ): Promise<void>;
        isComplete(): boolean | null;
        isComplete(): boolean | null;
        matches(request: OngoingRequest): MaybePromise<boolean>;
        matches(request: OngoingRequest): MaybePromise<boolean>;
    }

    Hierarchy (View Summary)

    Implements

    Implemented by

    Index
    id priority requestCount requests
    dispose explain handle isComplete matches
    id: string
    priority: number
    requestCount: number = 0
    requests: Promise<CompletedRequest>[]

    • Parameters

      • withoutExactCompletion: boolean = false

      Returns string

    • Parameters

      • request: OngoingRequest
      • response: Socket
      • head: Buffer
      • options: {
            debug: boolean;
            emitEventCallback?: (type: string, event: unknown) => void;
            keyLogStream?: Writable;
            record: boolean;
        }

      Returns Promise<void>

    • Parameters

      • req: OngoingRequest
      • res: Socket
      • head: Buffer
      • options: {
            debug: boolean;
            emitEventCallback?: (type: string, event: unknown) => void;
            keyLogStream?: Writable;
            record: boolean;
        }

      Returns Promise<void>

    Settings
    Member Visibility

    On This Page
    Properties
    Methods