WebSocketRule | mockttp
Hierarchy (view full)
- Explainable
- WebSocketRule
Implements
Implemented by
Index
Constructors
constructor
- new
Web (data): WebSocketRuleSocket Rule Returns WebSocketRule
Methods
dispose
explain
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
OptionalemitEvent ?: ((type: string, event: unknown) => void)Callback - (type, event): void
Parameters
- type: string
- event: unknown
Returns void
OptionalkeyLog ?: WritableStream 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
OptionalemitEvent ?: ((type: string, event: unknown) => void)Callback - (type, event): void
Parameters
- type: string
- event: unknown
Returns void
OptionalkeyLog ?: WritableStream record: boolean
Returns Promise<void>