UpstreamPullRequest.ts overview
Since v2.0.0
Exports Grouped by Category
constructors
NoUpstream
Signature
declare const NoUpstream: (activeDownstreamCount: number) => UpstreamPullRequest<never>
Since v2.0.0
Pulled
Signature
declare const Pulled: <A>(value: A) => UpstreamPullRequest<A>
Since v2.0.0
folding
match
Folds an UpstreamPullRequest<A>
into a value of type Z
.
Signature
declare const match: {
<A, Z>(options: {
readonly onPulled: (value: A) => Z
readonly onNoUpstream: (activeDownstreamCount: number) => Z
}): (self: UpstreamPullRequest<A>) => Z
<A, Z>(
self: UpstreamPullRequest<A>,
options: { readonly onPulled: (value: A) => Z; readonly onNoUpstream: (activeDownstreamCount: number) => Z }
): Z
}
Since v2.0.0
models
NoUpstream (interface)
Signature
export interface NoUpstream extends UpstreamPullRequest.Variance<never> {
readonly _tag: "NoUpstream"
readonly activeDownstreamCount: number
}
Since v2.0.0
Pulled (interface)
Signature
export interface Pulled<out A> extends UpstreamPullRequest.Variance<A> {
readonly _tag: "Pulled"
readonly value: A
}
Since v2.0.0
UpstreamPullRequest (type alias)
Signature
type UpstreamPullRequest<A> = Pulled<A> | NoUpstream
Since v2.0.0
refinements
isNoUpstream
Returns true
if the specified UpstreamPullRequest
is a NoUpstream
, false
otherwise.
Signature
declare const isNoUpstream: <A>(self: UpstreamPullRequest<A>) => self is NoUpstream
Since v2.0.0
isPulled
Returns true
if the specified UpstreamPullRequest
is a Pulled
, false
otherwise.
Signature
declare const isPulled: <A>(self: UpstreamPullRequest<A>) => self is Pulled<A>
Since v2.0.0
isUpstreamPullRequest
Returns true
if the specified value is an UpstreamPullRequest
, false
otherwise.
Signature
declare const isUpstreamPullRequest: (u: unknown) => u is UpstreamPullRequest<unknown>
Since v2.0.0
symbols
UpstreamPullRequestTypeId
Signature
declare const UpstreamPullRequestTypeId: unique symbol
Since v2.0.0
UpstreamPullRequestTypeId (type alias)
Signature
type UpstreamPullRequestTypeId = typeof UpstreamPullRequestTypeId
Since v2.0.0
utils
UpstreamPullRequest (namespace)
Since v2.0.0
Variance (interface)
Signature
export interface Variance<out A> {
readonly [UpstreamPullRequestTypeId]: {
readonly _A: Types.Covariant<A>
}
}
Since v2.0.0