Skip to main content Link Search Menu Expand Document (external link)

UpstreamPullStrategy overview

Added in v2.0.0


Table of contents


constructors

PullAfterAllEnqueued

Signature

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

Added in v2.0.0

PullAfterNext

Signature

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

Added in v2.0.0

folding

match

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

Signature

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

Added in v2.0.0

models

PullAfterAllEnqueued (interface)

Signature

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

Added in v2.0.0

PullAfterNext (interface)

Signature

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

Added in v2.0.0

UpstreamPullStrategy (type alias)

Signature

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

Added in v2.0.0

refinements

isPullAfterAllEnqueued

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

Signature

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

Added in v2.0.0

isPullAfterNext

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

Signature

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

Added in v2.0.0

isUpstreamPullStrategy

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

Signature

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

Added in v2.0.0

symbols

UpstreamPullStrategyTypeId

Signature

export declare const UpstreamPullStrategyTypeId: typeof UpstreamPullStrategyTypeId

Added in v2.0.0

UpstreamPullStrategyTypeId (type alias)

Signature

export type UpstreamPullStrategyTypeId = typeof UpstreamPullStrategyTypeId

Added in v2.0.0

utils

UpstreamPullStrategy (namespace)

Added in v2.0.0

Variance (interface)

Signature

export interface Variance<out A> {
  readonly [UpstreamPullStrategyTypeId]: {
    readonly _A: Types.Covariant<A>
  }
}

Added in v2.0.0