Sync / foldkit-durable

JournalDefinition

interface · packages/durable/src/node.ts:98

interface JournalDefinition<
  Operation,
  Snapshot,
  Principal,
  OperationEncoded = unknown,
> {
  readonly key: string
  readonly tag: ReturnType<
    typeof JournalService<Operation, Snapshot, Principal, OperationEncoded>
  >
  readonly layer: <SnapshotEncoded = unknown>(
    options: JournalOptions<
      Operation,
      Snapshot,
      Principal,
      OperationEncoded,
      SnapshotEncoded
    >,
  ) => Layer.Layer<
    JournalShape<Operation, Snapshot, Principal, OperationEncoded>,
    JournalError | UnsupportedJournalVersionError
  >
}

One journal's service tag together with the layer that satisfies it, both built from the same type parameters, so the tag cannot be read back as a journal of some other shape.

Members

JournalDefinition.key

property · packages/durable/src/node.ts:99

readonly key: string

JournalDefinition.tag

property · packages/durable/src/node.ts:100

readonly tag: ReturnType<
  typeof JournalService<Operation, Snapshot, Principal, OperationEncoded>
>

JournalDefinition.layer

property · packages/durable/src/node.ts:101

readonly layer: <SnapshotEncoded = unknown>(
  options: JournalOptions<
    Operation,
    Snapshot,
    Principal,
    OperationEncoded,
    SnapshotEncoded
  >,
) => Layer.Layer<
  JournalShape<Operation, Snapshot, Principal, OperationEncoded>,
  JournalError | UnsupportedJournalVersionError
>