Ref.ts overview
Since v2.0.0
Exports Grouped by Category
constructors
make
Signature
declare const make: <A>(value: A) => Effect.Effect<Ref<A>>
Since v2.0.0
getters
get
Signature
declare const get: <A>(self: Ref<A>) => Effect.Effect<A>
Since v2.0.0
models
Ref (interface)
Signature
export interface Ref<in out A> extends Ref.Variance<A>, Effect.Effect<A>, Readable.Readable<A> {
modify<B>(f: (a: A) => readonly [B, A]): Effect.Effect<B>
readonly [Unify.typeSymbol]?: unknown
readonly [Unify.unifySymbol]?: RefUnify<this>
readonly [Unify.ignoreSymbol]?: RefUnifyIgnore
}
Since v2.0.0
Ref (namespace)
Since v2.0.0
Variance (interface)
Signature
export interface Variance<in out A> {
readonly [RefTypeId]: {
readonly _A: Types.Invariant<A>
}
}
Since v2.0.0
RefUnify (interface)
Signature
export interface RefUnify<A extends { [Unify.typeSymbol]?: any }> extends Effect.EffectUnify<A> {
Ref?: () => Extract<A[Unify.typeSymbol], Ref<any>>
}
Since v3.8.0
RefUnifyIgnore (interface)
Signature
export interface RefUnifyIgnore extends Effect.EffectUnifyIgnore {
Effect?: true
}
Since v3.8.0
symbols
RefTypeId
Signature
declare const RefTypeId: unique symbol
Since v2.0.0
RefTypeId (type alias)
Signature
type RefTypeId = typeof RefTypeId
Since v2.0.0
unsafe
unsafeMake
Signature
declare const unsafeMake: <A>(value: A) => Ref<A>
Since v2.0.0
utils
getAndSet
Signature
declare const getAndSet: {
<A>(value: A): (self: Ref<A>) => Effect.Effect<A>
<A>(self: Ref<A>, value: A): Effect.Effect<A>
}
Since v2.0.0
getAndUpdate
Signature
declare const getAndUpdate: {
<A>(f: (a: A) => A): (self: Ref<A>) => Effect.Effect<A>
<A>(self: Ref<A>, f: (a: A) => A): Effect.Effect<A>
}
Since v2.0.0
getAndUpdateSome
Signature
declare const getAndUpdateSome: {
<A>(pf: (a: A) => Option.Option<A>): (self: Ref<A>) => Effect.Effect<A>
<A>(self: Ref<A>, pf: (a: A) => Option.Option<A>): Effect.Effect<A>
}
Since v2.0.0
modify
Signature
declare const modify: {
<A, B>(f: (a: A) => readonly [B, A]): (self: Ref<A>) => Effect.Effect<B>
<A, B>(self: Ref<A>, f: (a: A) => readonly [B, A]): Effect.Effect<B>
}
Since v2.0.0
modifySome
Signature
declare const modifySome: {
<B, A>(fallback: B, pf: (a: A) => Option.Option<readonly [B, A]>): (self: Ref<A>) => Effect.Effect<B>
<A, B>(self: Ref<A>, fallback: B, pf: (a: A) => Option.Option<readonly [B, A]>): Effect.Effect<B>
}
Since v2.0.0
set
Signature
declare const set: {
<A>(value: A): (self: Ref<A>) => Effect.Effect<void>
<A>(self: Ref<A>, value: A): Effect.Effect<void>
}
Since v2.0.0
setAndGet
Signature
declare const setAndGet: {
<A>(value: A): (self: Ref<A>) => Effect.Effect<A>
<A>(self: Ref<A>, value: A): Effect.Effect<A>
}
Since v2.0.0
update
Signature
declare const update: {
<A>(f: (a: A) => A): (self: Ref<A>) => Effect.Effect<void>
<A>(self: Ref<A>, f: (a: A) => A): Effect.Effect<void>
}
Since v2.0.0
updateAndGet
Signature
declare const updateAndGet: {
<A>(f: (a: A) => A): (self: Ref<A>) => Effect.Effect<A>
<A>(self: Ref<A>, f: (a: A) => A): Effect.Effect<A>
}
Since v2.0.0
updateSome
Signature
declare const updateSome: {
<A>(f: (a: A) => Option.Option<A>): (self: Ref<A>) => Effect.Effect<void>
<A>(self: Ref<A>, f: (a: A) => Option.Option<A>): Effect.Effect<void>
}
Since v2.0.0
updateSomeAndGet
Signature
declare const updateSomeAndGet: {
<A>(pf: (a: A) => Option.Option<A>): (self: Ref<A>) => Effect.Effect<A>
<A>(self: Ref<A>, pf: (a: A) => Option.Option<A>): Effect.Effect<A>
}
Since v2.0.0