Kaizen
Browse modulesFormsforms/sharedTypes

Type Alias: SavePort

type SavePort = (payload: SavePayload) => Promise<void>;

Defined in: shared/forms/save-port.ts:39

Persistence port a builder UI's state hook calls on every save and import-confirmation.

Contract:

  • MUST throw (or return a rejected promise) on error. The caller's hook is expected to gate its error state on rejection and, for the regular save path, to skip any post-save "mark fields saved" bookkeeping so fields stay editable for retry.
  • SHOULD resolve only after the write is committed. Implementers are free to also surface a success toast or call router.refresh() before resolving.
  • Called once per user-initiated save; the caller does not retry.

Parameters

ParameterType
payloadSavePayload

Returns

Promise<void>

On this page