Search
Preparing search index...
The search index is not available
mockttp
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
mockttp
WebSocketRule
Class WebSocketRule
Hierarchy
Explainable
WebSocketRule
Implements
WebSocketRule
Implemented by
WebSocketRule
Index
Constructors
constructor
Properties
id
priority
request
Count
requests
Methods
dispose
explain
handle
is
Complete
matches
Constructors
constructor
new
Web
Socket
Rule
(
data
:
WebSocketRuleData
)
:
WebSocketRule
Parameters
data:
WebSocketRuleData
Returns
WebSocketRule
Properties
id
id
:
string
Readonly
priority
priority
:
number
request
Count
request
Count
:
number
= 0
requests
requests
:
Promise
<
CompletedRequest
>
[]
Methods
dispose
dispose
(
)
:
void
Returns
void
explain
explain
(
withoutExactCompletion
?:
boolean
)
:
string
Parameters
withoutExactCompletion:
boolean
= false
Returns
string
handle
handle
(
request
:
OngoingRequest
, response
:
Socket
, head
:
Buffer
, record
:
boolean
)
:
Promise
<
void
>
handle
(
req
:
OngoingRequest
, res
:
Socket
, head
:
Buffer
, record
:
boolean
)
:
Promise
<
void
>
Parameters
request:
OngoingRequest
response:
Socket
head:
Buffer
record:
boolean
Returns
Promise
<
void
>
Parameters
req:
OngoingRequest
res:
Socket
head:
Buffer
record:
boolean
Returns
Promise
<
void
>
is
Complete
is
Complete
(
)
:
null
|
boolean
is
Complete
(
)
:
null
|
boolean
Returns
null
|
boolean
Returns
null
|
boolean
matches
matches
(
request
:
OngoingRequest
)
:
MaybePromise
<
boolean
>
matches
(
request
:
OngoingRequest
)
:
Promise
<
boolean
>
Parameters
request:
OngoingRequest
Returns
MaybePromise
<
boolean
>
Parameters
request:
OngoingRequest
Returns
Promise
<
boolean
>
Exports
Mockttp
Pluggable
Admin
Pluggable
Admin
completion
Checkers
matchers
request
Handler
Definitions
request
Handlers
web
Socket
Handler
Definitions
web
Socket
Handlers
Web
Socket
Rule
constructor
id
priority
request
Count
requests
dispose
explain
handle
is
Complete
matches
Generated using
TypeDoc