Skip to content
Effect 4.0 is here. One ecosystem. Zero dependencies.

Resource

10 exports Since v2.0.0 Source

Constructors

auto

Since v2.0.0

Creates a new Resource value that is automatically refreshed according to the specified policy. Note that error retrying is not performed automatically, so if you want to retry on errors, you should first apply retry policies to the acquisition effect before passing it to this constructor.

Signature

declare const auto: <A, E, R, Out, R2>(acquire: Effect.Effect<A, E, R>, policy: Schedule.Schedule<Out, unknown, R2>) => Effect.Effect<Resource<A, E>, never, R | R2 | Scope.Scope>

manual

Since v2.0.0

Creates a new Resource value that must be manually refreshed by calling the refresh method. Note that error retrying is not performed automatically, so if you want to retry on errors, you should first apply retry policies to the acquisition effect before passing it to this constructor.

Signature

declare const manual: <A, E, R>(acquire: Effect.Effect<A, E, R>) => Effect.Effect<Resource<A, E>, never, Scope.Scope | R>

Getters

get

Since v2.0.0

Retrieves the current value stored in the cache.

Signature

declare const get: <A, E>(self: Resource<A, E>) => Effect.Effect<A, E>

Models

Resource

interface
Since v2.0.0

A Resource is a possibly resourceful value that is loaded into memory, and which can be refreshed either manually or automatically.

Signature

interface Resource<in out A, in out E = never> extends Effect<A, E>, Variance<A, E> {
  readonly [ignoreSymbol]?: ResourceUnifyIgnore;
  readonly [typeSymbol]?: unknown;
  readonly [unifySymbol]?: ResourceUnify<Resource<A, E>>;
}

ResourceUnify

interface
Since v3.9.0

Signature

interface ResourceUnify<A extends {
  [typeSymbol]?: any;
}> extends EffectUnify<A> {
  Resource?: () => Extract<A[typeof typeSymbol], Resource<any, any>>;
}

ResourceUnifyIgnore

interface
Since v3.9.0

Signature

interface ResourceUnifyIgnore extends EffectUnifyIgnore {
  Effect?: true;
}

Other

Resource

Since v2.0.0

Symbols

ResourceTypeId

Since v2.0.0

Signature

declare const ResourceTypeId: unique symbol

ResourceTypeId

type
Since v2.0.0

Signature

type ResourceTypeId = typeof ResourceTypeId

Utils

refresh

Since v2.0.0

Refreshes the cache. This method will not return until either the refresh is successful, or the refresh operation fails.

Signature

declare const refresh: <A, E>(self: Resource<A, E>) => Effect.Effect<void, E>