- Alt
- Alternative
- Applicative
- Apply
- Chain
- ChainRec
- Compactable
- Filterable
- FromEither
- FromIO
- Functor
- Monad
- MonadIO
- MonadThrow
- Pointed
- Zero
export declare const Alt: Alt1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Alternative: Alternative1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Applicative: Applicative1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Apply: Apply1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Chain: chainable.Chain1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
ChainRec for IOOption
export declare const ChainRec: ChainRec1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2022-present Jacob Alford
export declare const Compactable: Compactable1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Filterable: Filterable1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const FromEither: FromEither1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const FromIO: FromIO1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Functor: Functor1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Monad: Monad1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const MonadIO: MonadIO1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const MonadThrow: MonadThrow1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Pointed: Pointed1<URI>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Zero: Zero1<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: {
<A, _>(self: IOOption<A>, f: (a: A) => IOOption<_>): IOOption<A>
<A, _>(f: (a: A) => IOOption<_>): (self: IOOption<A>) => IOOption<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 tapEither: {
<A, E, _>(f: (a: A) => Either<E, _>): (self: IOOption<A>) => IOOption<A>
<A, E, _>(self: IOOption<A>, f: (a: A) => Either<E, _>): IOOption<A>
}
- Added in 0.1.0
import { pipe } from '@fp-tx/core/function'
import * as IOO from '@fp-tx/core/IOOption'
import * as O from '@fp-tx/core/Option'
import * as E from '@fp-tx/core/Either'
const compute = (value: number) =>
pipe(
IOO.of(value),
IOO.tapEither(value => (value > 0 ? E.right('ok') : E.left('error'))),
)
assert.deepStrictEqual(compute(1)(), O.of(1))
assert.deepStrictEqual(compute(-1)(), O.none)
- 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<_>): (self: IOOption<A>) => IOOption<A>
<A, _>(self: IOOption<A>, f: (a: A) => IO<_>): IOOption<A>
}
- Added in 0.1.0
import { pipe } from '@fp-tx/core/function'
import * as IOO from '@fp-tx/core/IOOption'
import * as O from '@fp-tx/core/Option'
import * as Console from '@fp-tx/core/Console'
// Will produce `Hello, fp-ts` to the stdout
const effectA = pipe(
IOO.of('fp-ts'),
IOO.tapIO(value => Console.log(`Hello, ${value}`)),
)
// No output to the stdout
const effectB = pipe(
IOO.none as IOO.IOOption<string>,
IOO.tapIO(value => Console.log(`Hello, ${value}`)),
)
async function test() {
assert.deepStrictEqual(effectA(), O.of('fp-ts'))
assert.deepStrictEqual(effectB(), O.none)
}
test()
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const none: IOOption<never>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const of: <A>(a: A) => IOOption<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const some: <A>(a: A) => IOOption<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromEither: <A>(fa: Either<unknown, A>) => IOOption<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromIO: <A>(fa: IO<A>) => IOOption<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromIOEither: <A>(fa: IOEither<unknown, A>) => IOOption<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromNullable: <A>(a: A) => IOOption<NonNullable<A>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromOption: <A>(fa: Option<A>) => IOOption<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const toNullable: <A>(ma: IOOption<A>) => IO<A | null>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const toUndefined: <A>(ma: IOOption<A>) => IO<A | undefined>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const Do: IOOption<{}>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const apS: <N extends string, A, B>(
name: Exclude<N, keyof A>,
fb: IOOption<B>,
) => (fa: IOOption<A>) => IOOption<{ 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 bind: <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => IOOption<B>,
) => (ma: IOOption<A>) => IOOption<{ 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) => <A>(fa: IOOption<A>) => IOOption<{ readonly [K in N]: A }>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const guard: (b: boolean) => IOOption<void>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const alt: <A>(second: LazyArg<IOOption<A>>) => (first: IOOption<A>) => IOOption<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Less strict version of alt
.
The W
suffix (short for Widening) means that the return types will be merged.
export declare const altW: <B>(second: LazyArg<IOOption<B>>) => <A>(first: IOOption<A>) => IOOption<A | B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const getOrElse: <A>(onNone: LazyArg<IO<A>>) => (fa: IOOption<A>) => IO<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Less strict version of getOrElse
.
The W
suffix (short for Widening) means that the handler return type will be merged.
export declare const getOrElseW: <B>(onNone: LazyArg<IO<B>>) => <A>(ma: IOOption<A>) => IO<A | B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const compact: Compactable1<URI>['compact']
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const filter: {
<A, B extends A>(refinement: Refinement<A, B>): (fb: IOOption<A>) => IOOption<B>
<A>(predicate: Predicate<A>): <B extends A>(fb: IOOption<B>) => IOOption<B>
<A>(predicate: Predicate<A>): (fa: IOOption<A>) => IOOption<A>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const filterMap: <A, B>(f: (a: A) => Option<B>) => (fga: IOOption<A>) => IOOption<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const partition: {
<A, B extends A>(refinement: Refinement<A, B>): (fb: IOOption<A>) => Separated<IOOption<A>, IOOption<B>>
<A>(predicate: Predicate<A>): <B extends A>(fb: IOOption<B>) => Separated<IOOption<B>, IOOption<B>>
<A>(predicate: Predicate<A>): (fa: IOOption<A>) => Separated<IOOption<A>, IOOption<A>>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const partitionMap: <A, B, C>(
f: (a: A) => Either<B, C>,
) => (fa: IOOption<A>) => Separated<IOOption<B>, IOOption<C>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const separate: Compactable1<URI>['separate']
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const chainRec: ChainRec1<URI>['chainRec']
- Added in 0.1.0
- MIT – Copyright (c) 2022-present Jacob Alford
Alias of flatMap
.
export declare const chain: <A, B>(f: (a: A) => IOOption<B>) => (ma: IOOption<A>) => IOOption<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of flatMapEither
.
export declare const chainEitherK: <E, A, B>(f: (a: A) => Either<E, B>) => (ma: IOOption<A>) => IOOption<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of tap
.
export declare const chainFirst: <A, B>(f: (a: A) => IOOption<B>) => (first: IOOption<A>) => IOOption<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of tapEither
.
export declare const chainFirstEitherK: <E, A, B>(f: (a: A) => Either<E, B>) => (ma: IOOption<A>) => IOOption<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>) => (first: IOOption<A>) => IOOption<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>) => (first: IOOption<A>) => IOOption<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of flatMapNullable
.
export declare const chainNullableK: <A, B>(
f: (a: A) => B | null | undefined,
) => (ma: IOOption<A>) => IOOption<NonNullable<B>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of flatMapOption
.
export declare const chainOptionK: <A, B>(f: (a: A) => Option<B>) => (ma: IOOption<A>) => IOOption<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromEitherK: <E, A extends ReadonlyArray<unknown>, B>(
f: (...a: A) => Either<E, B>,
) => (...a: A) => IOOption<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>) => (...a: A) => IOOption<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromNullableK: <A extends ReadonlyArray<unknown>, B>(
f: (...a: A) => B | null | undefined,
) => (...a: A) => IOOption<NonNullable<B>>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromOptionK: <A extends ReadonlyArray<unknown>, B>(
f: (...a: A) => Option<B>,
) => (...a: A) => IOOption<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const fromPredicate: {
<A, B extends A>(refinement: Refinement<A, B>): (a: A) => IOOption<B>
<A>(predicate: Predicate<A>): <B extends A>(b: B) => IOOption<B>
<A>(predicate: Predicate<A>): (a: A) => IOOption<A>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Maps the Some
value of this IOOption
to the specified constant value.
export declare const as: {
<A>(a: A): <_>(self: IOOption<_>) => IOOption<A>
<_, A>(self: IOOption<_>, a: A): IOOption<A>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Maps the Some
value of this IOOption
to the void constant value.
export declare const asUnit: <_>(self: IOOption<_>) => IOOption<void>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flap: <A>(a: A) => <B>(fab: IOOption<(a: A) => B>) => IOOption<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) => (fa: IOOption<A>) => IOOption<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export interface IOOption<A> extends IO<Option<A>> {}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Alias of matchE
.
export declare const fold: <B, A>(onNone: () => I.IO<B>, onSome: (a: A) => I.IO<B>) => (ma: IOOption<A>) => I.IO<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const match: <B, A>(onNone: () => B, onSome: (a: A) => B) => (ma: IOOption<A>) => IO<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
The E
suffix (short for Effect) means that the handlers return an effect (IO
).
export declare const matchE: <B, A>(onNone: () => IO<B>, onSome: (a: A) => IO<B>) => (ma: IOOption<A>) => IO<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Less strict version of matchE
.
The W
suffix (short for Widening) means that the handler return types will be merged.
export declare const matchEW: <B, C, A>(onNone: () => IO<B>, onSome: (a: A) => IO<C>) => (ma: IOOption<A>) => IO<B | C>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Less strict version of match
.
The W
suffix (short for Widening) means that the handler return types will be merged.
export declare const matchW: <B, A, C>(onNone: () => B, onSome: (a: A) => C) => (ma: IOOption<A>) => IO<B | C>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flatMap: {
<A, B>(f: (a: A) => IOOption<B>): (ma: IOOption<A>) => IOOption<B>
<A, B>(ma: IOOption<A>, f: (a: A) => IOOption<B>): IOOption<B>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flatMapEither: {
<A, B, _>(f: (a: A) => Either<_, B>): (self: IOOption<A>) => IOOption<B>
<A, B, _>(self: IOOption<A>, f: (a: A) => Either<_, B>): IOOption<B>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flatMapIO: {
<A, B>(f: (a: A) => IO<B>): (self: IOOption<A>) => IOOption<B>
<A, B>(self: IOOption<A>, f: (a: A) => IO<B>): IOOption<B>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flatMapNullable: {
<A, B>(f: (a: A) => B | null | undefined): (self: IOOption<A>) => IOOption<B>
<A, B>(self: IOOption<A>, f: (a: A) => B | null | undefined): IOOption<B>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flatMapOption: {
<A, B>(f: (a: A) => Option<B>): (self: IOOption<A>) => IOOption<B>
<A, B>(self: IOOption<A>, f: (a: A) => Option<B>): IOOption<B>
}
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const flatten: <A>(mma: IOOption<IOOption<A>>) => IOOption<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Equivalent to ReadonlyArray#traverseWithIndex(Applicative)
.
export declare const traverseReadonlyArrayWithIndex: <A, B>(
f: (index: number, a: A) => IOOption<B>,
) => (as: readonly A[]) => IOOption<readonly B[]>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
Equivalent to ReadonlyNonEmptyArray#traverseWithIndex(Applicative)
.
export declare const traverseReadonlyNonEmptyArrayWithIndex: <A, B>(
f: (index: number, a: A) => IOOption<B>,
) => (as: ReadonlyNonEmptyArray<A>) => IOOption<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 = 'IOOption'
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const ApT: IOOption<readonly []>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const ap: <A>(fa: IOOption<A>) => <B>(fab: IOOption<(a: A) => B>) => IOOption<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: <B>(second: IOOption<B>) => <A>(first: IOOption<A>) => IOOption<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: <B>(second: IOOption<B>) => <A>(first: IOOption<A>) => IOOption<B>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const do_: <MA extends IOOptionIterable<any>, A>(
yieldFunction: (unwrap: <A>(ma: IOOption<A>) => IOOptionIterable<A>) => Generator<MA, A>,
) => IOOption<A>
export declare const let_: <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => B,
) => (fa: IOOption<A>) => IOOption<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }>
export declare const throwError: MonadThrow1<URI>['throwError']
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti
export declare const zero: <A>() => IOOption<A>
- Added in 0.1.0
- MIT – Copyright (c) 2017-present Giulio Canti