ReactiveRef overview
Added in v1.0.0
Table of contents
Combinators
get
Signature
export declare const get: <A>(self: ReadonlyReactiveRef<A>) => Effect.Effect<A>
Added in v1.0.0
modify
Signature
export declare const modify: {
<R, A>(f: (_: A) => readonly [returnValue: R, nextValue: A]): (self: ReactiveRef<A>) => Effect.Effect<R>
<A, R>(self: ReactiveRef<A>, f: (_: A) => readonly [returnValue: R, nextValue: A]): Effect.Effect<R>
}
Added in v1.0.0
set
Signature
export declare const set: {
<A>(value: A): (self: ReactiveRef<A>) => Effect.Effect<void>
<A>(self: ReactiveRef<A>, value: A): Effect.Effect<void>
}
Added in v1.0.0
subscribe
Signature
export declare const subscribe: <A>(self: ReadonlyReactiveRef<A>) => Effect.Effect<A, never, Reactive>
Added in v1.0.0
subscribeResult
Signature
export declare const subscribeResult: <A, E>(
self: ReactiveRef<Result.Result<A, E>>
) => Effect.Effect<Result.Success<A, E> | Result.Failure<A, E>, never, Reactive>
Added in v1.0.0
subscribeResultUnwrap
Signature
export declare const subscribeResultUnwrap: <A, E>(
self: ReadonlyReactiveRef<Result.Result<A, E>>
) => Effect.Effect<A, E, Reactive>
Added in v1.0.0
unsafeGet
Signature
export declare const unsafeGet: <A>(self: ReactiveRef<A>) => A
Added in v1.0.0
unsafeModify
Signature
export declare const unsafeModify: {
<R, A>(f: (_: A) => readonly [returnValue: R, nextValue: A]): (self: ReactiveRef<A>) => R
<A, R>(self: ReactiveRef<A>, f: (_: A) => readonly [returnValue: R, nextValue: A]): R
}
Added in v1.0.0
unsafeSet
Signature
export declare const unsafeSet: {
<A>(value: A): (self: ReactiveRef<A>) => void
<A>(self: ReactiveRef<A>, value: A): void
}
Added in v1.0.0
unsafeUpdate
Signature
export declare const unsafeUpdate: {
<A>(f: (_: A) => A): (self: ReactiveRef<A>) => void
<A>(self: ReactiveRef<A>, f: (_: A) => A): void
}
Added in v1.0.0
update
Signature
export declare const update: {
<A>(f: (_: A) => A): (self: ReactiveRef<A>) => Effect.Effect<void>
<A>(self: ReactiveRef<A>, f: (_: A) => A): Effect.Effect<void>
}
Added in v1.0.0
Constructors
make
Signature
export declare const make: <A>(value: A) => Effect.Effect<ReactiveRef<A>>
Added in v1.0.0
unsafeMake
Signature
export declare const unsafeMake: <A>(value: A) => ReactiveRef<A>
Added in v1.0.0
Conversions
fromEffect
Signature
export declare const fromEffect: <A, E, R>(
effect: Effect.Effect<A, E, R>
) => Effect.Effect<ReadonlyReactiveRef<Result.Result<A, E>>, never, R | Scope.Scope>
Added in v1.0.0
fromStream
Signature
export declare const fromStream: <A, E, R>(
stream: Stream.Stream<A, E, R>
) => Effect.Effect<ReadonlyReactiveRef<Result.Result<A, E | Cause.NoSuchElementException>>, never, R | Scope.Scope>
Added in v1.0.0
fromStreamPull
Signature
export declare const fromStreamPull: <A, E, R>(
stream: Stream.Stream<A, E, R>
) => Effect.Effect<
{ readonly ref: ReadonlyReactiveRef<PullResult<A, E>>; readonly pull: () => void },
never,
R | Scope.Scope
>
Added in v1.0.0
into
Signature
export declare const into: {
<A, E>(
self: ReactiveRef<Result.Result<A, E>>
): <R>(effect: Effect.Effect<A, E, R>) => Effect.Effect<void, never, R | Scope.Scope>
<A, E, R>(
self: ReactiveRef<Result.Result<A, E>>,
effect: Effect.Effect<A, E, R>
): Effect.Effect<void, never, R | Scope.Scope>
}
Added in v1.0.0
intoStream
Signature
export declare const intoStream: {
<A, E>(
self: ReactiveRef<Result.Result<A, E | Cause.NoSuchElementException>>
): <R>(stream: Stream.Stream<A, E, R>) => Effect.Effect<void, never, R | Scope.Scope>
<A, E, R>(
self: ReactiveRef<Result.Result<A, E | Cause.NoSuchElementException>>,
stream: Stream.Stream<A, E, R>
): Effect.Effect<void, never, R | Scope.Scope>
}
Added in v1.0.0
intoStreamPull
Signature
export declare const intoStreamPull: {
<A, E>(
self: ReactiveRef<PullResult<A, E>>
): <R>(stream: Stream.Stream<A, E, R>) => Effect.Effect<() => void, never, R | Scope.Scope>
<A, E, R>(
self: ReactiveRef<PullResult<A, E>>,
stream: Stream.Stream<A, E, R>
): Effect.Effect<() => void, never, R | Scope.Scope>
}
Added in v1.0.0
Models
ReactiveRef (interface)
Signature
export interface ReactiveRef<in out A> extends ReadonlyReactiveRef<A> {
readonly [TypeId]: TypeId
subscribe(notifiable: Notifiable): void
unsafeSet(value: A): void
value: A
}
Added in v1.0.0
ReadonlyReactiveRef (interface)
Signature
export interface ReadonlyReactiveRef<out A> extends Handle, Effect.Effect<A, never, Reactive> {
readonly [TypeId]: TypeId
subscribe(notifiable: Notifiable): void
value: A
}
Added in v1.0.0
Symbols
TypeId
Signature
export declare const TypeId: typeof TypeId
Added in v1.0.0
TypeId (type alias)
Signature
export type TypeId = typeof TypeId
Added in v1.0.0