MockttpServer | mockttp
Hierarchy
- AbstractMockttp
- MockttpServer
Implements
Index
Events
on
- on(event, callback): Promise<void>
Parameters
- event: "request-initiated"
- callback: ((req: Request) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "request-body-data"
- callback: ((req: BodyData) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "request"
- callback: ((req: CompletedRequest) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "response-initiated"
- callback: ((req: InitiatedResponse) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "response-body-data"
- callback: ((req: BodyData) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "response"
- callback: ((req: CompletedResponse) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "abort"
- callback: ((req: Request) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "websocket-request"
- callback: ((req: CompletedRequest) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "websocket-accepted"
- callback: ((req: CompletedResponse) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "websocket-message-received"
- callback: ((req: WebSocketMessage) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "websocket-message-sent"
- callback: ((req: WebSocketMessage) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "websocket-close"
- callback: ((close: WebSocketClose) => void)
- (close): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "tls-passthrough-opened"
- callback: ((req: TlsPassthroughEvent) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "tls-passthrough-closed"
- callback: ((req: TlsPassthroughEvent) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "tls-client-error"
- callback: ((req: TlsHandshakeFailure) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "client-error"
- callback: ((error: ClientError) => void)
- (error): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "raw-passthrough-opened"
- callback: ((req: RawPassthroughEvent) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "raw-passthrough-closed"
- callback: ((req: RawPassthroughEvent) => void)
- (req): void
Returns void
Returns Promise<void>
- on(event, callback): Promise<void>
Parameters
- event: "raw-passthrough-data"
- callback: ((req: RawPassthroughDataEvent) => void)
- (req): void
Returns void
Returns Promise<void>
- on<T>(event, callback): Promise<void>
Type Parameters
Returns Promise<void>
Manual rule definition
addRequestRule
- add
Request (rule): Promise<MockedEndpoint>Rule Returns Promise<MockedEndpoint>
addRequestRules
- add
Request (...ruleData): Promise<ServerMockedEndpoint[]>Rules Returns Promise<ServerMockedEndpoint[]>
addWebSocketRule
- add
Web (rule): Promise<MockedEndpoint>Socket Rule Returns Promise<MockedEndpoint>
addWebSocketRules
- add
Web (...ruleData): Promise<ServerMockedEndpoint[]>Socket Rules Returns Promise<ServerMockedEndpoint[]>
setRequestRules
- set
Request (...ruleData): Promise<ServerMockedEndpoint[]>Rules Returns Promise<ServerMockedEndpoint[]>
setWebSocketRules
- set
Web (...ruleData): Promise<ServerMockedEndpoint[]>Socket Rules Returns Promise<ServerMockedEndpoint[]>
Metadata
port
- get port(): number
Returns number
proxyEnv
- get proxyEnv(): ProxyEnvConfig
Returns ProxyEnvConfig
url
- get url(): string
Returns string
getMockedEndpoints
- get
Mocked (): Promise<ServerMockedEndpoint[]>Endpoints Returns Promise<ServerMockedEndpoint[]>
getPendingEndpoints
- get
Pending (): Promise<ServerMockedEndpoint[]>Endpoints Returns Promise<ServerMockedEndpoint[]>
getRuleParameterKeys
urlFor
Mock HTTP requests
forAnyRequest
- for
Any (): RequestRuleBuilderRequest Returns RequestRuleBuilder
forDelete
- for
Delete (url?): RequestRuleBuilder Parameters
Optionalurl: string | RegExp
Returns RequestRuleBuilder
forGet
- for
Get (url?): RequestRuleBuilder Parameters
Optionalurl: string | RegExp
Returns RequestRuleBuilder
forHead
- for
Head (url?): RequestRuleBuilder Parameters
Optionalurl: string | RegExp
Returns RequestRuleBuilder
forJsonRpcRequest
- for
Json (match?): RequestRuleBuilderRpc Request Parameters
- match: {
method?: string;
params?: any;
} = {}Optionalmethod?: stringOptionalparams?: any
Returns RequestRuleBuilder
- match: {
forOptions
- for
Options (url?): RequestRuleBuilder Parameters
Optionalurl: string | RegExp
Returns RequestRuleBuilder
forPatch
- for
Patch (url?): RequestRuleBuilder Parameters
Optionalurl: string | RegExp
Returns RequestRuleBuilder
forPost
- for
Post (url?): RequestRuleBuilder Parameters
Optionalurl: string | RegExp
Returns RequestRuleBuilder
forPut
- for
Put (url?): RequestRuleBuilder Parameters
Optionalurl: string | RegExp
Returns RequestRuleBuilder
forUnmatchedRequest
- for
Unmatched (): RequestRuleBuilderRequest Returns RequestRuleBuilder
Mock websockets
forAnyWebSocket
- for
Any (url?): WebSocketRuleBuilderWeb Socket Parameters
Optionalurl: string | RegExp
Returns WebSocketRuleBuilder
Other
constructor
- new
Mockttp (options?): MockttpServerServer Returns MockttpServer
listenerCount
Setup
enableDebug
reset
start
- start(portParam?): Promise<void>
Parameters
- portParam: number | PortRange = ...
Returns Promise<void>