WebSocketRule | mockttp

Hierarchy (view full)

Implements

Implemented by

Constructors

constructor

Properties

id

id: string

Readonlypriority

priority: number

requestCount

requestCount: number = 0

requests

Methods

dispose

  • dispose(): void
  • Returns void

explain

  • explain(withoutExactCompletion?): string
  • Parameters

    • withoutExactCompletion: boolean = false

    Returns string

handle

  • handle(request, response, head, options): Promise<void>
  • Parameters

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

            • type: string
            • event: unknown

            Returns void

      • OptionalkeyLogStream?: Writable
      • record: boolean

    Returns Promise<void>

  • handle(req, res, head, options): Promise<void>
  • Parameters

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

            • type: string
            • event: unknown

            Returns void

      • OptionalkeyLogStream?: Writable
      • record: boolean

    Returns Promise<void>

isComplete

  • isComplete(): null | boolean
  • Returns null | boolean

  • isComplete(): null | boolean
  • Returns null | boolean

matches

  • matches(request): MaybePromise<boolean>
  • Returns MaybePromise<boolean>

  • matches(request): MaybePromise<boolean>
  • Returns MaybePromise<boolean>