Skip to content

Response

ResponseFull

ResponseFull = Prettify<As<"ResponseFull"> & object>

A complete response with all metadata and raw content.


ResponseViewModeOptions

ResponseViewModeOptions<TProps> = object

Options for defining a custom response view mode.

Type Parameters

Type Parameter
TProps extends ResponseViewModeProps | ResponseViewModePropsInternal

Properties

label

label: string

The label of the view mode.

view

view: ComponentDefinition<TProps>

The component to render when the view mode is selected.

when()?

optional when: (response: ResponseFull, request: RequestMeta | RequestFull) => boolean

A function that determines if the view mode should be shown for a given response.

Parameters
ParameterType
responseResponseFull
requestRequestMeta | RequestFull
Returns

boolean


ResponseViewModeProps

ResponseViewModeProps = ResponseViewModePropsInternal & object

The props for the response view mode.

Type Declaration

sdk

sdk: Caido


ResponseViewModePropsInternal

ResponseViewModePropsInternal = object

The internal props for the response view mode.

Properties

response

response: ResponseFull

view

view: EditorView