Remote / foldkit-remote-domain/imported

ImportedConfig

interface · packages/remote-domain/src/imported/mutation.ts:15

interface ImportedConfig<E extends AnyEntity, Refused> {
  readonly entity: E
  readonly footprint?: DeclaredFootprint<E['name']> | UnknownFootprint
  readonly refusal?: Schema.Codec<Refused, any>
}

What Imported.mutation takes besides the Api and the command's name.

Members

ImportedConfig.entity

property · packages/remote-domain/src/imported/mutation.ts:17

readonly entity: E

The Entity whose rows the command changes: the one its View serves.

ImportedConfig.footprint

property · packages/remote-domain/src/imported/mutation.ts:23

readonly footprint?: DeclaredFootprint<E['name']> | UnknownFootprint

What the command reads and writes of that Entity, on whose word: Footprint.declared({ writes: [Product.fields.note], by }). Without it the footprint is Footprint.unknown, which Remote reads as no word at all.

ImportedConfig.refusal

property · packages/remote-domain/src/imported/mutation.ts:25

readonly refusal?: Schema.Codec<Refused, any>

What the server may refuse the mutation with; Schema.Never when none.