dots.typescript.server.protocol.response

Response by server to client request message.

Response by server to client request message.

raw docstring

body^cljs

(body response)

Contains message body if success === true.

Returns: any

Contains message body if success === true.

**Returns:** `any`

source raw docstring

command^cljs

(command response)

The command requested.

Returns: string

The command requested.

**Returns:** `string`

source raw docstring

message^cljs

(message response)

If success === false, this should always be provided. Otherwise, may (or may not) contain a success message.

Returns: string | undefined

If success === false, this should always be provided.
Otherwise, may (or may not) contain a success message.

**Returns:** `string | undefined`

source raw docstring

metadata^cljs

(metadata response)

Contains extra information that plugin can include to be passed on

Returns: unknown

Contains extra information that plugin can include to be passed on

**Returns:** `unknown`

source raw docstring

performance-data^cljs

(performance-data response)

Exposes information about the performance of this request-response pair.

Returns: PerformanceData | undefined

Exposes information about the performance of this request-response pair.

**Returns:** `PerformanceData | undefined`

source raw docstring

request-seq^cljs

(request-seq response)

Sequence number of the request message.

Returns: number

Sequence number of the request message.

**Returns:** `number`

source raw docstring

seq^cljs

(seq response)

Sequence number of the message

Returns: number

Sequence number of the message

**Returns:** `number`

source raw docstring

set-body!^cljs

(set-body! response value)

Contains message body if success === true.

Contains message body if success === true.

source raw docstring

set-command!^cljs

(set-command! response value)

The command requested.

The command requested.

source raw docstring

set-message!^cljs

(set-message! response value)

If success === false, this should always be provided. Otherwise, may (or may not) contain a success message.

If success === false, this should always be provided.
Otherwise, may (or may not) contain a success message.

source raw docstring

set-metadata!^cljs

(set-metadata! response value)

Contains extra information that plugin can include to be passed on

Contains extra information that plugin can include to be passed on

source raw docstring

set-performance-data!^cljs

(set-performance-data! response value)

Exposes information about the performance of this request-response pair.

Exposes information about the performance of this request-response pair.

source raw docstring

set-request-seq!^cljs

(set-request-seq! response value)

Sequence number of the request message.

Sequence number of the request message.

source raw docstring

set-seq!^cljs

(set-seq! response value)

Sequence number of the message

Sequence number of the message

source raw docstring

set-success!^cljs

(set-success! response value)

Outcome of the request.

Outcome of the request.

source raw docstring

set-type!^cljs

(set-type! response value)

source

success?^cljs

(success? response)

Outcome of the request.

Returns: boolean

Outcome of the request.

**Returns:** `boolean`

source raw docstring

type^cljs

(type response)

Returns: "response"

**Returns:** `"response"`

source raw docstring