- chain
- chainFirst
- chainFirstIOK
- chainFirstReaderK
- chainFirstReaderKW
- chainFirstW
- chainIOK
- chainReaderK
- chainReaderKW
- chainW
- sequenceArray
- traverseArray
- traverseArrayWithIndex
- traverseReadonlyArrayWithIndex
- traverseReadonlyNonEmptyArrayWithIndex
export declare const Applicative: Applicative2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Apply: Apply2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Chain: chainable.Chain2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
ChainRec for ReaderIO
export declare const ChainRec: ChainRec2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2022-present Jacob Alford
export declare const FromIO: FromIO2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const FromReader: FromReader2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Functor: Functor2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Monad: Monad2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const MonadIO: MonadIO2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Pointed: Pointed2<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Composes computations in sequence, using the return value of one computation to determine the next computation and keeping only the result of the first.
export declare const tap: {
<R1, A, R2, _>(self: ReaderIO<R1, A>, f: (a: A) => ReaderIO<R2, _>): ReaderIO<R1 & R2, A>
<A, R2, _>(f: (a: A) => ReaderIO<R2, _>): <R1>(self: ReaderIO<R1, A>) => ReaderIO<R2 & R1, A>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Composes computations in sequence, using the return value of one computation to determine the next computation and keeping only the result of the first.
export declare const tapIO: {
<A, _>(f: (a: A) => IO<_>): <R>(self: ReaderIO<R, A>) => ReaderIO<R, A>
<R, A, _>(self: ReaderIO<R, A>, f: (a: A) => IO<_>): ReaderIO<R, A>
}
- Added in 0.1.0
import { pipe } from '@fp-tx/core/function'
import * as RIO from '@fp-tx/core/ReaderIO'
import * as Console from '@fp-tx/core/Console'
// Will produce `Hello, fp-ts` to the stdout
const effect = pipe(
RIO.ask<string>(),
RIO.tapIO(value => Console.log(`Hello, ${value}`)),
)
async function test() {
assert.deepStrictEqual(effect('fp-ts')(), 'fp-ts')
}
test()
- MIT – Copyright (c) 2017-present Giulio Canti
Composes computations in sequence, using the return value of one computation to determine the next computation and keeping only the result of the first.
export declare const tapReader: {
<R2, A, _>(f: (a: A) => Reader<R2, _>): <R1>(self: ReaderIO<R1, A>) => ReaderIO<R1 & R2, A>
<R1, A, R2, _>(self: ReaderIO<R1, A>, f: (a: A) => Reader<R2, _>): ReaderIO<R1 & R2, A>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Reads the current context.
export declare const ask: <R>() => ReaderIO<R, R>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Projects a value from the global context in a ReaderIO
.
export declare const asks: <R, A>(f: (r: R) => A) => ReaderIO<R, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Effectfully accesses the environment.
export declare const asksReaderIO: <R, A>(f: (r: R) => ReaderIO<R, A>) => ReaderIO<R, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Less strict version of asksReaderIO
.
The W
suffix (short for Widening) means that the environment types will be merged.
export declare const asksReaderIOW: <R1, R2, A>(f: (r1: R1) => ReaderIO<R2, A>) => ReaderIO<R1 & R2, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const of: <R = unknown, A = never>(a: A) => ReaderIO<R, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromIO: <A, R = unknown>(fa: IO<A>) => ReaderIO<R, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromReader: <R, A>(fa: Reader<R, A>) => ReaderIO<R, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Do: ReaderIO<unknown, {}>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const apS: <N extends string, A, E, B>(
name: Exclude<N, keyof A>,
fb: ReaderIO<E, B>,
) => (fa: ReaderIO<E, A>) => ReaderIO<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Less strict version of apS
.
The W
suffix (short for Widening) means that the environment types will be merged.
export declare const apSW: <N extends string, A, R2, B>(
name: Exclude<N, keyof A>,
fb: ReaderIO<R2, B>,
) => <R1>(fa: ReaderIO<R1, A>) => ReaderIO<
R1 & R2,
{
readonly [K in keyof A | N]: K extends keyof A ? A[K] : B
}
>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const bind: <N extends string, A, E, B>(
name: Exclude<N, keyof A>,
f: (a: A) => ReaderIO<E, B>,
) => (ma: ReaderIO<E, A>) => ReaderIO<E, { readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const bindTo: <N extends string>(
name: N,
) => <E, A>(fa: ReaderIO<E, A>) => ReaderIO<E, { readonly [K in N]: A }>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
The W
suffix (short for Widening) means that the environment types will be merged.
export declare const bindW: <N extends string, A, R2, B>(
name: Exclude<N, keyof A>,
f: (a: A) => ReaderIO<R2, B>,
) => <R1>(fa: ReaderIO<R1, A>) => ReaderIO<
R1 & R2,
{
readonly [K in keyof A | N]: K extends keyof A ? A[K] : B
}
>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const chainRec: ChainRec2<URI>['chainRec']
- Added in 0.1.0
- MIT – Copyright (c) 2022-present Jacob Alford
Alias of flatMap
.
export declare const chain: <A, R, B>(f: (a: A) => ReaderIO<R, B>) => (ma: ReaderIO<R, A>) => ReaderIO<R, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of tap
.
export declare const chainFirst: <A, R, B>(f: (a: A) => ReaderIO<R, B>) => (first: ReaderIO<R, A>) => ReaderIO<R, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of tapIO
.
export declare const chainFirstIOK: <A, B>(f: (a: A) => I.IO<B>) => <E>(first: ReaderIO<E, A>) => ReaderIO<E, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of tapReader
.
export declare const chainFirstReaderK: <A, R, B>(f: (a: A) => R.Reader<R, B>) => (ma: ReaderIO<R, A>) => ReaderIO<R, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of tapReader
.
Less strict version of chainFirstReaderK
.
The W
suffix (short for Widening) means that the environment types will be merged.
export declare const chainFirstReaderKW: <A, R1, B>(
f: (a: A) => R.Reader<R1, B>,
) => <R2>(ma: ReaderIO<R2, A>) => ReaderIO<R1 & R2, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of tap
.
export declare const chainFirstW: <A, R2, B>(
f: (a: A) => ReaderIO<R2, B>,
) => <R1>(ma: ReaderIO<R1, A>) => ReaderIO<R1 & R2, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of flatMapIO
.
export declare const chainIOK: <A, B>(f: (a: A) => I.IO<B>) => <E>(first: ReaderIO<E, A>) => ReaderIO<E, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of flatMapReader
.
export declare const chainReaderK: <A, R, B>(f: (a: A) => R.Reader<R, B>) => (ma: ReaderIO<R, A>) => ReaderIO<R, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of flatMapReader
.
Less strict version of chainReaderK
.
The W
suffix (short for Widening) means that the environment types will be merged.
export declare const chainReaderKW: <A, R1, B>(
f: (a: A) => R.Reader<R1, B>,
) => <R2>(ma: ReaderIO<R2, A>) => ReaderIO<R1 & R2, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of flatMap
.
export declare const chainW: <A, R2, B>(
f: (a: A) => ReaderIO<R2, B>,
) => <R1>(ma: ReaderIO<R1, A>) => ReaderIO<R1 & R2, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromIOK: <A extends ReadonlyArray<unknown>, B>(
f: (...a: A) => I.IO<B>,
) => <R = unknown>(...a: A) => ReaderIO<R, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromReaderK: <A extends ReadonlyArray<unknown>, R, B>(
f: (...a: A) => R.Reader<R, B>,
) => (...a: A) => ReaderIO<R, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Maps the value to the specified constant value.
export declare const as: {
<A>(a: A): <R, _>(self: ReaderIO<R, _>) => ReaderIO<R, A>
<R, _, A>(self: ReaderIO<R, _>, a: A): ReaderIO<R, A>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Maps the value to the void constant value.
export declare const asUnit: <R, _>(self: ReaderIO<R, _>) => ReaderIO<R, void>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flap: <A>(a: A) => <E, B>(fab: ReaderIO<E, (a: A) => B>) => ReaderIO<E, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
map
can be used to turn functions (a: A) => B
into functions (fa: F<A>) => F<B>
whose argument and return types use the type constructor F
to represent some computational context.
export declare const map: <A, B>(f: (a: A) => B) => <R>(fa: ReaderIO<R, A>) => ReaderIO<R, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export interface ReaderIO<R, A> {
(r: R): I.IO<A>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flatMap: {
<A, R2, B>(f: (a: A) => ReaderIO<R2, B>): <R1>(ma: ReaderIO<R1, A>) => ReaderIO<R1 & R2, B>
<R1, A, R2, B>(ma: ReaderIO<R1, A>, f: (a: A) => ReaderIO<R2, B>): ReaderIO<R1 & R2, B>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flatMapIO: {
<A, B>(f: (a: A) => IO<B>): <R>(self: ReaderIO<R, A>) => ReaderIO<R, B>
<R, A, B>(self: ReaderIO<R, A>, f: (a: A) => IO<B>): ReaderIO<R, B>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flatMapReader: {
<A, R2, B>(f: (a: A) => Reader<R2, B>): <R1>(self: ReaderIO<R1, A>) => ReaderIO<R1 & R2, B>
<R1, A, R2, B>(self: ReaderIO<R1, A>, f: (a: A) => Reader<R2, B>): ReaderIO<R1 & R2, B>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flatten: <R, A>(mma: ReaderIO<R, ReaderIO<R, A>>) => ReaderIO<R, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Less strict version of flatten
.
The W
suffix (short for Widening) means that the environment types will be merged.
export declare const flattenW: <R1, R2, A>(mma: ReaderIO<R1, ReaderIO<R2, A>>) => ReaderIO<R1 & R2, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Equivalent to ReadonlyArray#sequence(Applicative)
.
export declare const sequenceArray: <R, A>(arr: ReadonlyArray<ReaderIO<R, A>>) => ReaderIO<R, ReadonlyArray<A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Equivalent to ReadonlyArray#traverse(Applicative)
.
export declare const traverseArray: <A, R, B>(
f: (a: A) => ReaderIO<R, B>,
) => (as: readonly A[]) => ReaderIO<R, readonly B[]>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Equivalent to ReadonlyArray#traverseWithIndex(Applicative)
.
export declare const traverseArrayWithIndex: <A, R, B>(
f: (index: number, a: A) => ReaderIO<R, B>,
) => (as: ReadonlyArray<A>) => ReaderIO<R, ReadonlyArray<B>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Equivalent to ReadonlyArray#traverseWithIndex(Applicative)
.
export declare const traverseReadonlyArrayWithIndex: <A, R, B>(
f: (index: number, a: A) => ReaderIO<R, B>,
) => (as: readonly A[]) => ReaderIO<R, readonly B[]>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Equivalent to ReadonlyNonEmptyArray#traverseWithIndex(Applicative)
.
export declare const traverseReadonlyNonEmptyArrayWithIndex: <A, R, B>(
f: (index: number, a: A) => ReaderIO<R, B>,
) => (as: ReadonlyNonEmptyArray<A>) => ReaderIO<R, ReadonlyNonEmptyArray<B>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export type URI = typeof URI
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const URI = 'ReaderIO'
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const ApT: ReaderIO<unknown, readonly []>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const ap: <R, A>(fa: ReaderIO<R, A>) => <B>(fab: ReaderIO<R, (a: A) => B>) => ReaderIO<R, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Combine two effectful actions, keeping only the result of the first.
export declare const apFirst: <E, B>(second: ReaderIO<E, B>) => <A>(first: ReaderIO<E, A>) => ReaderIO<E, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Combine two effectful actions, keeping only the result of the second.
export declare const apSecond: <E, B>(second: ReaderIO<E, B>) => <A>(first: ReaderIO<E, A>) => ReaderIO<E, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Less strict version of ap
.
The W
suffix (short for Widening) means that the environment types will be merged.
export declare const apW: <R2, A>(
fa: ReaderIO<R2, A>,
) => <R1, B>(fab: ReaderIO<R1, (a: A) => B>) => ReaderIO<R1 & R2, B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const do_: <MA extends ReaderIOIterable<any, any>, A>(
yieldFunction: (unwrap: <R, A>(ma: ReaderIO<R, A>) => ReaderIOIterable<R, A>) => Generator<MA, A>,
) => ReaderIO<_.UnionToIntersection<MA extends ReaderIOIterable<infer R, any> ? R : never>, A>
Changes the value of the local context during the execution of the action ma
(similar to Contravariant
's contramap
).
export declare const local: <R2, R1>(f: (r2: R2) => R1) => <A>(ma: ReaderIO<R1, A>) => ReaderIO<R2, A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti