Skip to content

UpstreamPullStrategy

12 exports Added in v2.0.0 Source

Constructors

Signature

declare const PullAfterAllEnqueued: <A>(emitSeparator: Option<A>) => UpstreamPullStrategy<A>;

Signature

declare const PullAfterNext: <A>(emitSeparator: Option<A>) => UpstreamPullStrategy<A>;

Folding

match

Added in v2.0.0 Source

Folds an UpstreamPullStrategy<A> into a value of type Z.

Signature

declare const match: {
  <A, Z>(options: {
    readonly onAllEnqueued: (emitSeparator: Option.Option<A>) => Z;
    readonly onNext: (emitSeparator: Option.Option<A>) => Z;
  }): (self: UpstreamPullStrategy<A>) => Z;
  <A, Z>(
    self: UpstreamPullStrategy<A>,
    options: {
      readonly onAllEnqueued: (emitSeparator: Option.Option<A>) => Z;
      readonly onNext: (emitSeparator: Option.Option<A>) => Z;
    },
  ): Z;
};

Models

PullAfterAllEnqueued interface

Added in v2.0.0 Source

Signature

interface PullAfterAllEnqueued<out A> extends Variance<A> {
  readonly _tag: "PullAfterAllEnqueued";
  readonly emitSeparator: Option<A>;
}

PullAfterNext interface

Added in v2.0.0 Source

Signature

interface PullAfterNext<out A> extends Variance<A> {
  readonly _tag: "PullAfterNext";
  readonly emitSeparator: Option<A>;
}

UpstreamPullStrategy type

Added in v2.0.0 Source

Signature

type UpstreamPullStrategy<A> = PullAfterNext<A> | PullAfterAllEnqueued<A>;

Other

Refinements

Returns true if the specified UpstreamPullStrategy is a PullAfterAllEnqueued, false otherwise.

Signature

declare const isPullAfterAllEnqueued: <A>(
  self: UpstreamPullStrategy<A>,
) => self is PullAfterAllEnqueued<A>;

Returns true if the specified UpstreamPullStrategy is a PullAfterNext, false otherwise.

Signature

declare const isPullAfterNext: <A>(self: UpstreamPullStrategy<A>) => self is PullAfterNext<A>;

Returns true if the specified value is an UpstreamPullStrategy, false otherwise.

Signature

declare const isUpstreamPullStrategy: (u: unknown) => u is UpstreamPullStrategy<unknown>;

Symbols

Signature

declare const UpstreamPullStrategyTypeId: unique symbol;

Signature

type UpstreamPullStrategyTypeId = typeof UpstreamPullStrategyTypeId;