Dex TypeScript SDK 1.44.0
    Preparing search index...

    Interface JoinRound

    Identifies one round of a Join and the number of branches that round started.

    Join.fork and Join.forkWithRoundKey create a JoinRound and pass the same value to every branch builder and to the join builder. Put it in the input of each branch Step, of the join Step, and of the next round's split Step. Treat it as an opaque token: pass it back to the Join methods and do not build or change one yourself.

    Dex stores a JoinRound inside Step inputs, so its JSON shape is a persistent format. The shape is {"roundKey": string, "branchCount": integer} in every Dex SDK. Use joinRoundCodec when a Step input is exactly a JoinRound. Inside a larger JSON input, the default JSON encoding of this object produces the same shape.

    class ReviewDocument implements Step<JoinRound> {
      public readonly inputCodec = joinRoundCodec;

      public getStepType(): string {
        return "ReviewDocument";
      }

      public execute(context: Context, round: JoinRound): StepDecision {
        return reviewCompleted.endBranch(context, round, "approved");
      }
    }

    1.44.0

    interface JoinRound {
        branchCount: number;
        roundKey: string;
    }
    Index

    Properties

    branchCount roundKey

    Properties

    branchCount: number

    Number of branches that the fork started for this round.

    It equals the number of branch builders passed to the fork and can be 0.

    roundKey: string

    ChannelMap instance key that holds this round's branch results.

    Join.fork uses the split Step's execution ID, such as RequestQuotes-2. Dex Web shows this key as the instance of the ChannelMap named after the Join.

    Settings

    Member Visibility

    On This Page

    Properties