Skip to content

ChildExecutorDecision

15 exports Added in v2.0.0 Source

Constructors

Close

Added in v2.0.0 Source

Signature

declare const Close: (value: unknown) => ChildExecutorDecision;

Continue

Added in v2.0.0 Source

Signature

declare const Continue: (_: void) => ChildExecutorDecision;

Yield

Added in v2.0.0 Source

Signature

declare const Yield: (_: void) => ChildExecutorDecision;

Folding

match

Added in v2.0.0 Source

Folds over a ChildExecutorDecision to produce a value of type A.

Signature

declare const match: {
  <A>(options: {
    readonly onClose: (value: unknown) => A;
    readonly onContinue: () => A;
    readonly onYield: () => A;
  }): (self: ChildExecutorDecision) => A;
  <A>(
    self: ChildExecutorDecision,
    options: {
      readonly onClose: (value: unknown) => A;
      readonly onContinue: () => A;
      readonly onYield: () => A;
    },
  ): A;
};

Models

Signature

type ChildExecutorDecision = Continue | Close | Yield;

Close interface

Added in v2.0.0 Source

Close the current substream with a given value and pass execution to the next substream

Signature

interface Close extends Proto {
  readonly _tag: "Close";
  readonly value: unknown;
}

Continue interface

Added in v2.0.0 Source

Continue executing the current substream

Signature

interface Continue extends Proto {
  readonly _tag: "Continue";
}

Yield interface

Added in v2.0.0 Source

Pass execution to the next substream. This either pulls a new element from upstream, or yields to an already created active substream.

Signature

interface Yield extends Proto {
  readonly _tag: "Yield";
}

Other

Refinements

Returns true if the specified value is a ChildExecutorDecision, false otherwise.

Signature

declare const isChildExecutorDecision: (u: unknown) => u is ChildExecutorDecision;

isClose

Added in v2.0.0 Source

Returns true if the specified ChildExecutorDecision is a Close, false otherwise.

Signature

declare const isClose: (self: ChildExecutorDecision) => self is Close;

isContinue

Added in v2.0.0 Source

Returns true if the specified ChildExecutorDecision is a Continue, false otherwise.

Signature

declare const isContinue: (self: ChildExecutorDecision) => self is Continue;

isYield

Added in v2.0.0 Source

Returns true if the specified ChildExecutorDecision is a Yield, false otherwise.

Signature

declare const isYield: (self: ChildExecutorDecision) => self is Yield;

Symbols

Signature

declare const ChildExecutorDecisionTypeId: unique symbol;

Signature

type ChildExecutorDecisionTypeId = typeof ChildExecutorDecisionTypeId;