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

TDeferred overview

Added in v1.0.0


Table of contents


constructors

make

Signature

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

Added in v1.0.0

getters

await

Signature

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

Added in v1.0.0

poll

Signature

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

Added in v1.0.0

models

TDeferred (interface)

Signature

export interface TDeferred<E, A> extends TDeferred.Variance<E, A> {}

Added in v1.0.0

mutations

done

Signature

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

Added in v1.0.0

fail

Signature

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

Added in v1.0.0

succeed

Signature

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

Added in v1.0.0

symbols

TDeferredTypeId

Signature

export declare const TDeferredTypeId: typeof TDeferredTypeId

Added in v1.0.0

TDeferredTypeId (type alias)

Signature

export type TDeferredTypeId = typeof TDeferredTypeId

Added in v1.0.0

utils

TDeferred (namespace)

Added in v1.0.0

Variance (interface)

Signature

export interface Variance<E, A> {
  readonly [TDeferredTypeId]: {
    readonly _E: (_: never) => E
    readonly _A: (_: never) => A
  }
}

Added in v1.0.0