Class Channel<T>

constructor

• new Channel<T>(name: string, codec: Codec<T>): Channel<T>

  Creates a Channel definition.

  Type Parameters

  • T

  Parameters

  • name: string

    Non-empty name without /, unique within the Flow.

  • codec: Codec<T>

    Element codec.

  Returns Channel<T>

Readonlycodec

Readonlyname

atLeast

• atLeast(count: number, conditionId?: string): Condition

  Creates a condition requiring at least count values.

  Parameters

  • count: number

    Inclusive non-negative lower bound.

  • OptionalconditionId: string

    Optional stable condition identifier.

  Returns Condition

  A condition without an upper bound.

atMost

• atMost(count: number, conditionId?: string): Condition

  Creates a non-blocking condition consuming up to count queued values. When its surrounding Wait completes, it consumes values queued then; an empty queue yields none.

  Parameters

  • count: number

    Inclusive non-negative upper bound.

  • OptionalconditionId: string

    Optional stable condition identifier.

  Returns Condition

  A condition without a positive lower bound.

delete

• delete(context: Context, messageId: string): void

  Stages best-effort deletion of one pending message from a handler.

  Parameters

  • context: Context

    Current Step, timeout-handler, or RPC Context.

  • messageId: string

    Non-empty server-assigned message ID.

  Returns void

findPendingMessage

• findPendingMessage(
      context: Context,
      messageId: string,
  ): ChannelMessage<T> | undefined

  Finds one message in the loaded pending snapshot.

  Parameters

  • context: Context

    Current Step, timeout-handler, or RPC Context.

  • messageId: string

    Server-assigned message ID.

  Returns ChannelMessage<T> | undefined

  The matching message, or undefined when absent from the snapshot.

forN

• forN(count: number, conditionId?: string): Condition

  Creates a condition consuming exactly count values.

  Parameters

  • count: number

    Required non-negative count.

  • OptionalconditionId: string

    Optional stable condition identifier.

  Returns Condition

  A condition with equal lower and upper bounds.

forOne

• forOne(conditionId?: string): Condition

  Creates a condition consuming exactly one value.

  Parameters

  • OptionalconditionId: string

    Optional stable condition identifier.

  Returns Condition

  An exact-one Channel condition.

pendingMessages

• pendingMessages(context: Context): readonly ChannelMessage<T>[]

  Returns the loaded pending-message snapshot in FIFO order.

  Parameters

  • context: Context

    Current Step, timeout-handler, or RPC Context.

  Returns readonly ChannelMessage<T>[]

  Immutable pending message IDs and decoded values.

  Throws

  ChannelMessagesNotLoadedError when this handler did not load the Channel's messages.

publish

• publish(context: Context, value: T): void

  Stages one value to append with the current decision.

  Parameters

  • context: Context

    Current Step or RPC Context.

  • value: T

    Typed value to append.

  Returns void

range

• range(atLeast?: number, atMost?: number, conditionId?: string): Condition

  Creates a bounded condition for queued Channel values. Dex waits only for atLeast, then consumes currently queued values up to atMost. Omitting atLeast makes the condition complete immediately.

  Parameters

  • OptionalatLeast: number

    Optional inclusive lower bound.

  • OptionalatMost: number

    Optional inclusive upper bound.

  • OptionalconditionId: string

    Optional stable condition identifier.

  Returns Condition

  A validated Channel condition.

results

• results(context: Context): readonly T[]

  Returns values selected by this Step's satisfied condition.

  Parameters

  • context: Context

    Current Step Context.

  Returns readonly T[]

  Ordered values, or an empty array when this Channel was not selected.

size

• size(context: Context): number

  Returns the current queued value count.

  Parameters

  • context: Context

    Current Step or RPC Context.

  Returns number

  Non-negative queued value count.