Skip to main content

Module: typedefs

Interfaces

Type Aliases

EventFilterFn

Ƭ EventFilterFn: (event: RecordingElement) => boolean

Type declaration

▸ (event): boolean

Parameters
NameType
eventRecordingElement
Returns

boolean

Defined in

src/typedefs.ts:128


InterceptorFn

Ƭ InterceptorFn: (operation: Operation, forward: NextLink) => Observable<FetchResult>

Type declaration

▸ (operation, forward): Observable<FetchResult>

Parameters
NameType
operationOperation
forwardNextLink
Returns

Observable<FetchResult>

Defined in

src/typedefs.ts:54


ManInTheMiddleFn

Ƭ ManInTheMiddleFn: (options: SubscribeMeta) => Observable<FetchResult>

Type declaration

▸ (options): Observable<FetchResult>

Parameters
NameType
optionsSubscribeMeta
Returns

Observable<FetchResult>

Defined in

src/typedefs.ts:59


Matcher

Ƭ Matcher: MatcherFn | MatcherObject

Leave undefined if you want to intercept every operation, otherwise provide either a matcher function or a matcher object with properties like clientName and/or a partial set of variables that have to match for a given operation to be intercepted

Defined in

src/typedefs.ts:80


MatcherFn

Ƭ MatcherFn: (operation: Operation) => boolean

Type declaration

▸ (operation): boolean

Parameters
NameType
operationOperation
Returns

boolean

Defined in

src/typedefs.ts:66


OnSubscribe

Ƭ OnSubscribe: (options: SubscribeMeta) => () => void

Type declaration

▸ (options): () => void

Parameters
NameType
optionsSubscribeMeta
Returns

fn

▸ (): void

Returns

void

Defined in

src/typedefs.ts:65


OnSubscribeCallback

Ƭ OnSubscribeCallback: (options: { observer: FetchResultSubscriptionObserver ; operation: Operation ; removeCallback: () => void }) => () => void | void

Type declaration

▸ (options): () => void | void

Parameters
NameType
optionsObject
options.observerFetchResultSubscriptionObserver
options.operationOperation
options.removeCallback() => void
Returns

() => void | void

Defined in

src/typedefs.ts:27


OperationObserverCallback

Ƭ OperationObserverCallback: (operation: Operation, observer: FetchResultSubscriptionObserver) => void

Type declaration

▸ (operation, observer): void

Parameters
NameType
operationOperation
observerFetchResultSubscriptionObserver
Returns

void

Defined in

src/typedefs.ts:33


PassthroughDisableFn

Ƭ PassthroughDisableFn: () => boolean

Type declaration

▸ (): boolean

Returns

boolean

Defined in

src/typedefs.ts:63


PassthroughEnableFn

Ƭ PassthroughEnableFn: (mitm?: ManInTheMiddleFn) => boolean

Type declaration

▸ (mitm?): boolean

Parameters
NameType
mitm?ManInTheMiddleFn
Returns

boolean

Defined in

src/typedefs.ts:64


RecordingElement

Ƭ RecordingElement: RecordingMarker | RecordingPoint

Defined in

src/typedefs.ts:82


RecordingElementWithFixtureData

Ƭ RecordingElementWithFixtureData: RecordingMarker | RecordingPointWithFixtureData

Defined in

src/typedefs.ts:87


RecordingElementWithFixtureMeta

Ƭ RecordingElementWithFixtureMeta: RecordingMarker | RecordingPointWithFixtureMeta

Defined in

src/typedefs.ts:83


Replacements

Ƭ Replacements: { key: string ; value: unknown }[]

Defined in

src/typedefs.ts:102


ResultFn

Ƭ ResultFn: (operation: Operation) => Result

Type declaration

▸ (operation): Result

Parameters
NameType
operationOperation
Returns

Result

Defined in

src/typedefs.ts:43


ResultOrFn

Ƭ ResultOrFn: Result | ResultFn

Defined in

src/typedefs.ts:44