Remote / foldkit-remote-domain/imported

OperationDescription

interface · packages/remote-domain/src/imported/describe.ts:29

interface OperationDescription {
  readonly id: string
  readonly kind: 'Command'
  readonly description: Option.Option<string>
  readonly input: JsonSchema
  readonly reply: Option.Option<JsonSchema>
  readonly rejections: ReadonlyArray<RejectionDescription>
  readonly mutation: string
  readonly footprint: Footprint
}

One command, as a mutation Remote sends.

Members

OperationDescription.id

property · packages/remote-domain/src/imported/describe.ts:31

readonly id: string

The Api's name and the command's tag: stable across releases.

OperationDescription.kind

property · packages/remote-domain/src/imported/describe.ts:32

readonly kind: 'Command'

OperationDescription.description

property · packages/remote-domain/src/imported/describe.ts:33

readonly description: Option.Option<string>

OperationDescription.input

property · packages/remote-domain/src/imported/describe.ts:34

readonly input: JsonSchema

OperationDescription.reply

property · packages/remote-domain/src/imported/describe.ts:36

readonly reply: Option.Option<JsonSchema>

None for a command that answers only its receipt.

OperationDescription.rejections

property · packages/remote-domain/src/imported/describe.ts:37

readonly rejections: ReadonlyArray<RejectionDescription>

OperationDescription.mutation

property · packages/remote-domain/src/imported/describe.ts:39

readonly mutation: string

The mutation it lands as.

OperationDescription.footprint

property · packages/remote-domain/src/imported/describe.ts:41

readonly footprint: Footprint

Its Entity's members it reads and writes: derived from a Write, declared, or unknown.