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

FiberRefs

14 exports Since v2.0.0 Source

Constructors

empty

Since v2.0.0

The empty collection of FiberRef values.

Signature

declare const empty: () => FiberRefs

Getters

fiberRefs

Since v2.0.0

Returns a set of each FiberRef in this collection.

Signature

declare const fiberRefs: (self: FiberRefs) => HashSet.HashSet<FiberRef.FiberRef<any>>

get

Since v2.0.0

Gets the value of the specified FiberRef in this collection of FiberRef values if it exists or None otherwise.

Signature

declare const get: {
  <A>(fiberRef: FiberRef<A>): (self: FiberRefs) => Option<A>;
  <A>(self: FiberRefs, fiberRef: FiberRef<A>): Option<A>;
}

getOrDefault

Since v2.0.0

Gets the value of the specified FiberRef in this collection of FiberRef values if it exists or the initial value of the FiberRef otherwise.

Signature

declare const getOrDefault: {
  <A>(fiberRef: FiberRef<A>): (self: FiberRefs) => A;
  <A>(self: FiberRefs, fiberRef: FiberRef<A>): A;
}

Models

FiberRefs

interface
Since v2.0.0

FiberRefs is a data type that represents a collection of FiberRef values.

This allows safely propagating FiberRef values across fiber boundaries, for example between an asynchronous producer and consumer.

Signature

interface FiberRefs extends Pipeable {
  readonly [FiberRefsSym]: typeof FiberRefsSym;
  readonly locals: Map<FiberRef<any>, readonly [readonly [Single, any], readonly [Single, any]]>;
}

Other

delete

Signature

declare const delete: {
  <A>(fiberRef: FiberRef<A>): (self: FiberRefs) => FiberRefs;
  <A>(self: FiberRefs, fiberRef: FiberRef<A>): FiberRefs;
}

Symbols

FiberRefsSym

Since v2.0.0

Signature

declare const FiberRefsSym: unique symbol

FiberRefsSym

type
Since v2.0.0

Signature

type FiberRefsSym = typeof FiberRefsSym

Unsafe

unsafeMake

Since v2.0.0

Note: it will not copy the provided Map, make sure to provide a fresh one.

Signature

declare const unsafeMake: (fiberRefLocals: Map<FiberRef.FiberRef<any>, Arr.NonEmptyReadonlyArray<readonly [FiberId.Single, any]>>) => FiberRefs

Utils

forkAs

Since v2.0.0

Forks this collection of fiber refs as the specified child fiber id. This will potentially modify the value of the fiber refs, as determined by the individual fiber refs that make up the collection.

Signature

declare const forkAs: {
  (childId: Single): (self: FiberRefs) => FiberRefs;
  (self: FiberRefs, childId: Single): FiberRefs;
}

joinAs

Since v2.0.0

Joins this collection of fiber refs to the specified collection, as the specified fiber id. This will perform diffing and merging to ensure preservation of maximum information from both child and parent refs.

Signature

declare const joinAs: {
  (fiberId: Single, that: FiberRefs): (self: FiberRefs) => FiberRefs;
  (self: FiberRefs, fiberId: Single, that: FiberRefs): FiberRefs;
}

setAll

Since v2.0.0

Set each ref to either its value or its default.

Signature

declare const setAll: (self: FiberRefs) => Effect.Effect<void>

updateAs

Since v2.0.0

Updates the value of the specified FiberRef using the provided FiberId

Signature

declare const updateAs: {
  <A>(options: {
    readonly fiberId: FiberId.Single;
    readonly fiberRef: FiberRef.FiberRef<A>;
    readonly value: A;
  }): (self: FiberRefs) => FiberRefs;
  <A>(self: FiberRefs, options: {
    readonly fiberId: FiberId.Single;
    readonly fiberRef: FiberRef.FiberRef<A>;
    readonly value: A;
  }): FiberRefs;
}

updateManyAs

Since v2.0.0

Updates the values of the specified FiberRef & value pairs using the provided FiberId

Signature

declare const updateManyAs: {
  (options: {
    readonly entries: readonly [readonly [FiberRef.FiberRef<any>, readonly [readonly [FiberId.Single, any], ...Array<readonly ...>]], ...Array<readonly [FiberRef.FiberRef<any>, readonly [readonly ..., ......]]>];
    readonly forkAs?: FiberId.Single;
  }): (self: FiberRefs) => FiberRefs;
  (self: FiberRefs, options: {
    readonly entries: readonly [readonly [FiberRef.FiberRef<any>, readonly [readonly [FiberId.Single, any], ...Array<readonly ...>]], ...Array<readonly [FiberRef.FiberRef<any>, readonly [readonly ..., ......]]>];
    readonly forkAs?: FiberId.Single;
  }): FiberRefs;
}