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

TDeferred overview

Added in v2.0.0


Table of contents


constructors

make

Signature

export declare const make: <A, E = never>() => STM.STM<TDeferred<A, E>>

Added in v2.0.0

getters

await

Signature

export declare const await: <A, E>(self: TDeferred<A, E>) => STM.STM<A, E>

Added in v2.0.0

poll

Signature

export declare const poll: <A, E>(self: TDeferred<A, E>) => STM.STM<Option.Option<Either.Either<A, E>>>

Added in v2.0.0

models

TDeferred (interface)

Signature

export interface TDeferred<in out A, in out E = never> extends TDeferred.Variance<A, E> {}

Added in v2.0.0

mutations

done

Signature

export declare const done: {
  <A, E>(either: Either.Either<A, E>): (self: TDeferred<A, E>) => STM.STM<boolean>
  <A, E>(self: TDeferred<A, E>, either: Either.Either<A, E>): STM.STM<boolean>
}

Added in v2.0.0

fail

Signature

export declare const fail: {
  <E>(error: E): <A>(self: TDeferred<A, E>) => STM.STM<boolean>
  <A, E>(self: TDeferred<A, E>, error: E): STM.STM<boolean>
}

Added in v2.0.0

succeed

Signature

export declare const succeed: {
  <A>(value: A): <E>(self: TDeferred<A, E>) => STM.STM<boolean>
  <A, E>(self: TDeferred<A, E>, value: A): STM.STM<boolean>
}

Added in v2.0.0

symbols

TDeferredTypeId

Signature

export declare const TDeferredTypeId: typeof TDeferredTypeId

Added in v2.0.0

TDeferredTypeId (type alias)

Signature

export type TDeferredTypeId = typeof TDeferredTypeId

Added in v2.0.0

utils

TDeferred (namespace)

Added in v2.0.0

Variance (interface)

Signature

export interface Variance<in out A, in out E> {
  readonly [TDeferredTypeId]: {
    readonly _A: Types.Invariant<A>
    readonly _E: Types.Invariant<E>
  }
}

Added in v2.0.0