Remote / foldkit-remote-domain

CommandBinding

interface · packages/remote-domain/src/adapter/binding.ts:167

interface CommandBinding<
  M extends AnyMutation = AnyMutation,
  A extends AnyApi = AnyApi,
> {
  readonly mutation: M
  readonly api: A
  readonly command: CommandNameOf<A>
  readonly entity: AnyEntity
  readonly target: (input: unknown) => string
  readonly input: (input: unknown) => unknown
  readonly rejections: ReadonlyArray<Domain.Rejection.Any>
  readonly refusals: ReadonlyMap<
    string,
    (rejection: unknown) => Outcome<unknown>
  >
  readonly written: Option.Option<
    (reply: unknown, input: unknown) => Readonly<Record<string, unknown>>
  >
}

A command bound to the mutation it lands.

Members

CommandBinding.mutation

property · packages/remote-domain/src/adapter/binding.ts:168

readonly mutation: M

CommandBinding.api

property · packages/remote-domain/src/adapter/binding.ts:169

readonly api: A

CommandBinding.command

property · packages/remote-domain/src/adapter/binding.ts:170

readonly command: CommandNameOf<A>

CommandBinding.entity

property · packages/remote-domain/src/adapter/binding.ts:172

readonly entity: AnyEntity

The Entity whose View key the command writes.

CommandBinding.target

property · packages/remote-domain/src/adapter/binding.ts:173

readonly target: (input: unknown) => string

CommandBinding.input

property · packages/remote-domain/src/adapter/binding.ts:174

readonly input: (input: unknown) => unknown

CommandBinding.rejections

property · packages/remote-domain/src/adapter/binding.ts:176

readonly rejections: ReadonlyArray<Domain.Rejection.Any>

Each Rejection the command declares, and how it reaches Remote, by tag.

CommandBinding.refusals

property · packages/remote-domain/src/adapter/binding.ts:177

readonly refusals: ReadonlyMap<
  string,
  (rejection: unknown) => Outcome<unknown>
>

CommandBinding.written

property · packages/remote-domain/src/adapter/binding.ts:178

readonly written: Option.Option<
  (reply: unknown, input: unknown) => Readonly<Record<string, unknown>>
>