Skip to content

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.


RequestViewModeOptions

RequestViewModeOptions = object

Options for defining a custom request view mode.

Properties

label

label: string

The label of the view mode.

view

view: ComponentDefinition

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