Caido
GuidesTutorialsReferenceConcepts

Utils ​

AddIndicatorOptions ​

AddIndicatorOptions = object

Visual indicator displayed next to a item label in a tree component. Includes an icon and an associated description.

Properties ​

description ​

description: string

icon ​

icon: Icon

As ​

As<TType> = object

Utility type that adds a type discriminator to a type.

Type Parameters ​

Type Parameter
TType extends string

Properties ​

type ​

type: TType

ComponentDefinition ​

ComponentDefinition = object

A custom component that will be rendered in the UI.

Properties ​

component ​

component: VueComponent

events? ​

optional events: Record<string, (...args: unknown[]) => void>

props? ​

optional props: Record<string, unknown>

HTTPQL ​

HTTPQL = string & object

An HTTPQL expression.

Type Declaration ​

__httpql? ​

optional __httpql: never

Example ​

ts
`req.method.eq:"POST"`

Icon ​

Icon = string & object

A https://fontawesome.com/icons|FontAwesome icon class.

Type Declaration ​

__icon? ​

optional __icon: never

Example ​

ts
"fas fa-rocket"

ID ​

ID = string & object

A unique Caido identifier per type.

Type Declaration ​

__id? ​

optional __id: never

Indicator ​

Indicator = object

Providing operations that can be performed on a item indicator.

Properties ​

remove() ​

remove: () => void

Returns ​

void

ListenerHandle ​

ListenerHandle = object

A handle for a listener.

Properties ​

stop() ​

stop: () => void

Stop the listener.

Returns ​

void

Prettify ​

Prettify<T> = { [K in keyof T]: T[K] } & object

Utility type that prettifies complex types for better IDE display.

Type Parameters ​

Type Parameter
T

PromisifiedReturnType ​

PromisifiedReturnType<T> = ReturnType<T> extends Promise<infer U> ? Promise<U> : Promise<ReturnType<T>>

Utility type for converting endpoint return types to promises.

Type Parameters ​

Type Parameter
T extends (...args: unknown[]) => unknown

Selection ​

Selection<TId> = { kind: "Empty"; } | { kind: "Selected"; main: TId; secondary: TId[]; }

Generic selection type with main and secondary items. Main represents the primary selected item, secondary represents additional selected items.

Type Parameters ​

Type Parameter
TId