MockRuleData | @kronoslive/mockttp

Index

Classes

Interfaces

CallbackHandlerResult

Type aliases

Functions

Object literals

Type aliases

CompletionCheckerBuilder

CompletionCheckerBuilder: function

Type declaration

- (data: D): RuleCompletionChecker
- Parameters
  - data: D
  Returns RuleCompletionChecker

CompletionCheckerData

CompletionCheckerData: AlwaysData | OnceData | TwiceData | ThriceData | TimesData

CompletionCheckerDataLookup

CompletionCheckerDataLookup: object

Type declaration

always: AlwaysData
once: OnceData
thrice: ThriceData
times: TimesData
twice: TwiceData

CompletionCheckerType

CompletionCheckerType: "always" | "once" | "twice" | "thrice" | "times"

HandlerBuilder

HandlerBuilder: function

Type declaration

- (data: D): RequestHandler
- Parameters
  - data: D
  Returns RequestHandler

HandlerData

HandlerData: SimpleHandlerData | CallbackHandlerData | PassThroughHandlerData

HandlerDataLookup

HandlerDataLookup: object

Type declaration

HandlerType

HandlerType: "simple" | "callback" | "passthrough"

MatcherBuilder

MatcherBuilder: function

Type declaration

- (data: D): RequestMatcher
- Parameters
  - data: D
  Returns RequestMatcher

MatcherData

MatcherData: WildcardMatcherData | SimpleMatcherData | HeaderMatcherData | FormDataMatcherData

MatcherDataLookup

MatcherDataLookup: object

Type declaration

MatcherType

MatcherType: "simple" | "wildcard" | "header" | "form-data"

Functions

buildCompletionChecker

buildCompletionChecker<T, D>(completionCheckerData?: D): RuleCompletionChecker | undefined

- Defined in rules/completion-checkers.ts:52
Type parameters
- T: CompletionCheckerType
- D: CompletionCheckerDataLookup[T]
Parameters
- Optional completionCheckerData: D
Returns RuleCompletionChecker | undefined

buildHandler

buildHandler<T, D>(handlerData: D): RequestHandler

- Defined in rules/handlers.ts:62
Type parameters
- T: HandlerType
- D: HandlerDataLookup[T]
Parameters
- handlerData: D
Returns RequestHandler

buildMatcher

buildMatcher<T, D>(matcherPartData: D): RequestMatcher

- Defined in rules/matchers.ts:73
Type parameters
- T: MatcherType
- D: MatcherDataLookup[T]
Parameters
- matcherPartData: D
Returns RequestMatcher

buildMatchers

buildMatchers(matcherPartData: MatcherData[]): RequestMatcher

- Defined in rules/matchers.ts:58
Parameters
- matcherPartData: MatcherData[]
Returns RequestMatcher

checkTimes

checkTimes(n: number): function

- Defined in rules/completion-checkers.ts:97
Parameters
- n: number
Returns function
- - (): boolean
  - Returns boolean

combineMatchers

combineMatchers(matcherA: RequestMatcher, matcherB: RequestMatcher): RequestMatcher

- Defined in rules/matchers.ts:122
Parameters
- matcherA: RequestMatcher
- matcherB: RequestMatcher
Returns RequestMatcher

explainUntil

explainUntil(requests: __type[], n: number, name: string): string

- Defined in rules/completion-checkers.ts:103
Parameters
- requests: __type[]
- n: number
- name: string
Returns string

withExplanation

withExplanation<T>(functionToExplain: T, explainer: function): T & RuleExplainable

- Defined in rules/completion-checkers.ts:108
Type parameters
- T: Function
Parameters
- functionToExplain: T
- explainer: function
  - - (this: MockRule): string
    - Parameters
      - this: MockRule
      Returns string
Returns T & RuleExplainable

Object literals

Const completionCheckerBuilders

completionCheckerBuilders: object

always

always(): (Anonymous function) & RuleExplainable

- Defined in rules/completion-checkers.ts:65
Returns (Anonymous function) & RuleExplainable

once

once(): function & RuleExplainable

- Defined in rules/completion-checkers.ts:71
Returns function & RuleExplainable

thrice

thrice(): function & RuleExplainable

- Defined in rules/completion-checkers.ts:83
Returns function & RuleExplainable

times

times(__namedParameters: object): function & RuleExplainable

- Defined in rules/completion-checkers.ts:89
Parameters
- __namedParameters: object
  - count: number
Returns function & RuleExplainable

twice

twice(): function & RuleExplainable

- Defined in rules/completion-checkers.ts:77
Returns function & RuleExplainable

Const handlerBuilders

handlerBuilders: object

callback

callback(__namedParameters: object): RequestHandler

- Defined in rules/handlers.ts:80
Parameters
- __namedParameters: object
  - callback: function
    - - (request: CompletedRequest): CallbackHandlerResult
      - Parameters
        
        request: CompletedRequest
        
        Returns CallbackHandlerResult
Returns RequestHandler

passthrough

passthrough(): RequestHandler

- Defined in rules/handlers.ts:108
Returns RequestHandler

simple

simple(__namedParameters: object): RequestHandler

- Defined in rules/handlers.ts:73
Parameters
- __namedParameters: object
  - data: undefined | string
  - headers: undefined | OutgoingHttpHeaders
  - status: number
Returns RequestHandler

Const matcherBuilders

matcherBuilders: object

Index

Classes

Interfaces

Type aliases

Functions

Object literals

Type aliases

CompletionCheckerBuilder

Type declaration

Parameters

data: D

Returns RuleCompletionChecker

CompletionCheckerData

CompletionCheckerDataLookup

Type declaration

always: AlwaysData

once: OnceData

thrice: ThriceData

times: TimesData

twice: TwiceData

CompletionCheckerType

HandlerBuilder

Type declaration

Parameters

data: D

Returns RequestHandler

HandlerData

HandlerDataLookup

Type declaration

callback: CallbackHandlerData

passthrough: PassThroughHandlerData

simple: SimpleHandlerData

HandlerType

MatcherBuilder

Type declaration

Parameters

data: D

Returns RequestMatcher

MatcherData

MatcherDataLookup

Type declaration

form-data: FormDataMatcherData

header: HeaderMatcherData

simple: SimpleMatcherData

wildcard: WildcardMatcherData

MatcherType

Functions

buildCompletionChecker

Type parameters

T: CompletionCheckerType

D: CompletionCheckerDataLookup[T]

Parameters

Optional completionCheckerData: D

Returns RuleCompletionChecker | undefined

buildHandler

Type parameters

T: HandlerType

D: HandlerDataLookup[T]

Parameters

handlerData: D

Returns RequestHandler

buildMatcher

Type parameters

T: MatcherType

D: MatcherDataLookup[T]

Parameters

matcherPartData: D

Returns RequestMatcher

buildMatchers

Parameters

matcherPartData: MatcherData[]

Returns RequestMatcher

checkTimes

Parameters

n: number

Returns function

Returns boolean

combineMatchers

Parameters

matcherA: RequestMatcher