Caido

Request ​

RequestDraft ​

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

A draft request that has not yet been saved to the database.

RequestFull ​

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

A complete request with all metadata and raw content.

RequestMeta ​

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

Metadata about a request without the raw content.

RequestReadableViewModeProps ​

RequestReadableViewModeProps = RequestReadableViewModePropsInternal & object

The props for the request read-only view mode.

Type Declaration ​

sdk ​

sdk: Caido

RequestReadableViewModePropsInternal ​

RequestReadableViewModePropsInternal = object

The internal props for the request read-only view mode.

Properties ​

request ​

request: RequestFull

view ​

view: EditorView

RequestViewModeOptions ​

RequestViewModeOptions<TProps> = object

Options for defining a custom request view mode.

Type Parameters ​

Type Parameter
TProps extends RequestViewModeProps

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: (request: RequestFull | RequestDraft) => boolean

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

Parameters ​
ParameterType
requestRequestFull | RequestDraft
Returns ​

boolean

RequestViewModeProps ​

RequestViewModeProps = RequestReadableViewModeProps | RequestWritableViewModeProps | RequestReadableViewModePropsInternal | RequestWritableViewModePropsInternal

The props group for the request view mode.

RequestWritableViewModeProps ​

RequestWritableViewModeProps = RequestWritableViewModePropsInternal & object

The props for the request writable view mode.

Type Declaration ​

sdk ​

sdk: Caido

RequestWritableViewModePropsInternal ​

RequestWritableViewModePropsInternal = object

The internal props for the request writable view mode.

Properties ​

draft ​

draft: RequestDraft

request ​

request: RequestFull | undefined

view ​

view: EditorView