Intercept

InterceptMessageId

InterceptMessageId = string & object

A unique intercept message identifier.

Type Declaration

__interceptMessageId?

optional __interceptMessageId: never

---

InterceptPageContext

InterceptPageContext = object

Intercept page context.

Properties

kind

kind: "Intercept"

requestSelection

requestSelection: Selection<InterceptMessageId>

responseSelection

responseSelection: Selection<InterceptMessageId>

websocketSelection

websocketSelection: Selection<InterceptMessageId>

---

InterceptSDK

InterceptSDK = object

Utilities to interact with the Intercept page.

Properties

addRequestViewMode()

addRequestViewMode: (options: RequestViewModeOptions<RequestWritableViewModeProps>) => void

Add a custom request view mode.

Parameters

Parameter	Type	Description
options	RequestViewModeOptions<RequestWritableViewModeProps>	The view mode options.

Returns

void

addResponseViewMode()

addResponseViewMode: (options: ResponseViewModeOptions<ResponseViewModeProps>) => void

Add a custom response view mode.

Parameters

Parameter	Type	Description
options	ResponseViewModeOptions<ResponseViewModeProps>	The view mode options.

Returns

void

getScopeId()

getScopeId: () => ID | undefined

Get the current scope ID.

Returns

ID | undefined

The current scope ID.

getSelectedRequest()

getSelectedRequest: () => RequestFull | undefined

Get the currently selected request.

Returns

RequestFull | undefined

The currently selected request.

getSelectedResponse()

getSelectedResponse: () => ResponseFull | undefined

Get the currently selected response.

Returns

ResponseFull | undefined

The currently selected response.

setScope()

setScope: (id: ID | undefined) => void

Set the current scope.

Parameters

Parameter	Type
id	ID | undefined

Returns

void