Remote / foldkit-remote-server

MutationOutcome

interface · packages/remote-server/src/index.ts:268

interface MutationOutcome<Output> {
  readonly output: Output
  readonly entities?: ReadonlyArray<NormalizedPatch>
  readonly connections?: ReadonlyArray<ConnectionChange>
  readonly deleted?: ReadonlyArray<{
    readonly entity: string
    readonly id: string
  }>
}

Members

MutationOutcome.output

property · packages/remote-server/src/index.ts:269

readonly output: Output

MutationOutcome.entities

property · packages/remote-server/src/index.ts:270

readonly entities?: ReadonlyArray<NormalizedPatch>

MutationOutcome.connections

property · packages/remote-server/src/index.ts:272

readonly connections?: ReadonlyArray<ConnectionChange>

Connection changes the mutation made; the client settles them with its patches.

MutationOutcome.deleted

property · packages/remote-server/src/index.ts:277

readonly deleted?: ReadonlyArray<{
  readonly entity: string
  readonly id: string
}>

Entities the mutation deleted. The client knows them absent from then on: they leave every connection and read NotFound, with no connection to name.