Interface ChannelProtocol<ValueType, UpdateType, CheckpointType>

lc_graph_name

UpdateType

ValueType

checkpoint

• checkpoint(): undefined | CheckpointType

  Return a string representation of the channel's current state.

  Returns undefined | CheckpointType

  Throws

  if the channel is empty (never updated yet), or doesn't support checkpoints.

fromCheckpoint

• fromCheckpoint(checkpoint?: CheckpointType): this

  Return a new identical channel, optionally initialized from a checkpoint. Can be thought of as a "restoration" from a checkpoint which is a "snapshot" of the channel's state.

  Parameters

  • Optionalcheckpoint: CheckpointType

  Returns this

get

• get(): ValueType

  Return the current value of the channel.

  Returns ValueType

  Throws

  if the channel is empty (never updated yet).

update

• update(values: UpdateType[]): void

  Update the channel's value with the given sequence of updates. The order of the updates in the sequence is arbitrary.

  Parameters

  • values: UpdateType[]

  Returns void

  Throws

  if the sequence of updates is invalid.