Skip to content

UpstreamPullRequest

12 exports Added in v2.0.0 Source

Constructors

NoUpstream

Added in v2.0.0 Source

Signature

declare const NoUpstream: (activeDownstreamCount: number) => UpstreamPullRequest<never>;

Pulled

Added in v2.0.0 Source

Signature

declare const Pulled: <A>(value: A) => UpstreamPullRequest<A>;

Folding

match

Added in v2.0.0 Source

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

Signature

declare const match: {
  <A, Z>(options: {
    readonly onNoUpstream: (activeDownstreamCount: number) => Z;
    readonly onPulled: (value: A) => Z;
  }): (self: UpstreamPullRequest<A>) => Z;
  <A, Z>(
    self: UpstreamPullRequest<A>,
    options: {
      readonly onNoUpstream: (activeDownstreamCount: number) => Z;
      readonly onPulled: (value: A) => Z;
    },
  ): Z;
};

Models

NoUpstream interface

Added in v2.0.0 Source

Signature

interface NoUpstream extends Variance<never> {
  readonly _tag: "NoUpstream";
  readonly activeDownstreamCount: number;
}

Pulled interface

Added in v2.0.0 Source

Signature

interface Pulled<out A> extends Variance<A> {
  readonly _tag: "Pulled";
  readonly value: A;
}

UpstreamPullRequest type

Added in v2.0.0 Source

Signature

type UpstreamPullRequest<A> = Pulled<A> | NoUpstream;

Other

Refinements

isNoUpstream

Added in v2.0.0 Source

Returns true if the specified UpstreamPullRequest is a NoUpstream, false otherwise.

Signature

declare const isNoUpstream: <A>(self: UpstreamPullRequest<A>) => self is NoUpstream;

isPulled

Added in v2.0.0 Source

Returns true if the specified UpstreamPullRequest is a Pulled, false otherwise.

Signature

declare const isPulled: <A>(self: UpstreamPullRequest<A>) => self is Pulled<A>;

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

Signature

declare const isUpstreamPullRequest: (u: unknown) => u is UpstreamPullRequest<unknown>;

Symbols

Signature

declare const UpstreamPullRequestTypeId: unique symbol;

Signature

type UpstreamPullRequestTypeId = typeof UpstreamPullRequestTypeId;