OperationDescription.id
property · packages/remote-domain/src/imported/describe.ts:31
readonly id: stringThe Api's name and the command's tag: stable across releases.
Remote / foldkit-remote-domain/imported
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.
OperationDescription.idproperty · packages/remote-domain/src/imported/describe.ts:31
readonly id: stringThe Api's name and the command's tag: stable across releases.
OperationDescription.kindproperty · packages/remote-domain/src/imported/describe.ts:32
readonly kind: 'Command'OperationDescription.descriptionproperty · packages/remote-domain/src/imported/describe.ts:33
readonly description: Option.Option<string>OperationDescription.inputproperty · packages/remote-domain/src/imported/describe.ts:34
readonly input: JsonSchemaOperationDescription.replyproperty · packages/remote-domain/src/imported/describe.ts:36
readonly reply: Option.Option<JsonSchema>None for a command that answers only its receipt.
OperationDescription.rejectionsproperty · packages/remote-domain/src/imported/describe.ts:37
readonly rejections: ReadonlyArray<RejectionDescription>OperationDescription.mutationproperty · packages/remote-domain/src/imported/describe.ts:39
readonly mutation: stringThe mutation it lands as.
OperationDescription.footprintproperty · packages/remote-domain/src/imported/describe.ts:41
readonly footprint: FootprintIts Entity's members it reads and writes: derived from a Write, declared, or unknown.