294 lines
8.9 KiB
TypeScript
294 lines
8.9 KiB
TypeScript
/**
|
|
* **This module is experimental**
|
|
*
|
|
* Experimental features are published in order to get early feedback from the community.
|
|
*
|
|
* A feature tagged as _Experimental_ is in a high state of flux, you're at risk of it changing without notice.
|
|
*
|
|
* An `Optional` is an optic used to zoom inside a product. Unlike the `Lens`, the element that the `Optional` focuses
|
|
* on may not exist.
|
|
*
|
|
* `Optional`s have two type parameters generally called `S` and `A`: `Optional<S, A>` where `S` represents the product
|
|
* and `A` an optional element inside of `S`.
|
|
*
|
|
* Laws:
|
|
*
|
|
* 1. `pipe(getOption(s), fold(() => s, a => set(a)(s))) = s`
|
|
* 2. `getOption(set(a)(s)) = pipe(getOption(s), map(_ => a))`
|
|
* 3. `set(a)(set(a)(s)) = set(a)(s)`
|
|
*
|
|
* @since 2.3.0
|
|
*/
|
|
import { Applicative, Applicative1, Applicative2, Applicative3 } from 'fp-ts/es6/Applicative'
|
|
import { Category2 } from 'fp-ts/es6/Category'
|
|
import { Either } from 'fp-ts/es6/Either'
|
|
import { Predicate, Refinement } from 'fp-ts/es6/function'
|
|
import { HKT, Kind, Kind2, Kind3, URIS, URIS2, URIS3 } from 'fp-ts/es6/HKT'
|
|
import { Invariant2 } from 'fp-ts/es6/Invariant'
|
|
import * as O from 'fp-ts/es6/Option'
|
|
import { ReadonlyNonEmptyArray } from 'fp-ts/es6/ReadonlyNonEmptyArray'
|
|
import { ReadonlyRecord } from 'fp-ts/es6/ReadonlyRecord'
|
|
import { Semigroupoid2 } from 'fp-ts/es6/Semigroupoid'
|
|
import { Traversable1 } from 'fp-ts/es6/Traversable'
|
|
import { Iso } from './Iso'
|
|
import { Lens } from './Lens'
|
|
import { Prism } from './Prism'
|
|
import { Traversal } from './Traversal'
|
|
import Option = O.Option
|
|
/**
|
|
* @category model
|
|
* @since 2.3.0
|
|
*/
|
|
export interface Optional<S, A> {
|
|
readonly getOption: (s: S) => Option<A>
|
|
readonly set: (a: A) => (s: S) => S
|
|
}
|
|
/**
|
|
* @category constructors
|
|
* @since 2.3.8
|
|
*/
|
|
export declare const optional: <S, A>(
|
|
getOption: Optional<S, A>['getOption'],
|
|
set: Optional<S, A>['set']
|
|
) => Optional<S, A>
|
|
/**
|
|
* @category constructors
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const id: <S>() => Optional<S, S>
|
|
/**
|
|
* View a `Optional` as a `Traversal`.
|
|
*
|
|
* @category converters
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const asTraversal: <S, A>(sa: Optional<S, A>) => Traversal<S, A>
|
|
/**
|
|
* Compose a `Optional` with a `Optional`.
|
|
*
|
|
* @category compositions
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const compose: <A, B>(ab: Optional<A, B>) => <S>(sa: Optional<S, A>) => Optional<S, B>
|
|
/**
|
|
* Alias of `compose`.
|
|
*
|
|
* @category compositions
|
|
* @since 2.3.8
|
|
*/
|
|
export declare const composeOptional: <A, B>(ab: Optional<A, B>) => <S>(sa: Optional<S, A>) => Optional<S, B>
|
|
/**
|
|
* Compose a `Optional` with a `Iso`.
|
|
*
|
|
* @category compositions
|
|
* @since 2.3.8
|
|
*/
|
|
export declare const composeIso: <A, B>(ab: Iso<A, B>) => <S>(sa: Optional<S, A>) => Optional<S, B>
|
|
/**
|
|
* Compose a `Optional` with a `Lens`.
|
|
*
|
|
* @category compositions
|
|
* @since 2.3.7
|
|
*/
|
|
export declare const composeLens: <A, B>(ab: Lens<A, B>) => <S>(sa: Optional<S, A>) => Optional<S, B>
|
|
/**
|
|
* Compose a `Optional` with a `Prism`.
|
|
*
|
|
* @category compositions
|
|
* @since 2.3.7
|
|
*/
|
|
export declare const composePrism: <A, B>(ab: Prism<A, B>) => <S>(sa: Optional<S, A>) => Optional<S, B>
|
|
/**
|
|
* Compose a `Optional` with an `Traversal`.
|
|
*
|
|
* @category compositions
|
|
* @since 2.3.8
|
|
*/
|
|
export declare const composeTraversal: <A, B>(ab: Traversal<A, B>) => <S>(sa: Optional<S, A>) => Traversal<S, B>
|
|
/**
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const modifyOption: <A, B extends A = A>(
|
|
f: (a: A) => B
|
|
) => <S>(optional: Optional<S, A>) => (s: S) => Option<S>
|
|
/**
|
|
* @category combinators
|
|
* @since 2.3.7
|
|
*/
|
|
export declare const setOption: <A>(a: A) => <S>(optional: Optional<S, A>) => (s: S) => O.Option<S>
|
|
/**
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const modify: <A, B extends A = A>(f: (a: A) => B) => <S>(optional: Optional<S, A>) => (s: S) => S
|
|
/**
|
|
* @category combinators
|
|
* @since 2.3.5
|
|
*/
|
|
export declare function modifyF<F extends URIS3>(
|
|
F: Applicative3<F>
|
|
): <A, R, E>(f: (a: A) => Kind3<F, R, E, A>) => <S>(sa: Optional<S, A>) => (s: S) => Kind3<F, R, E, S>
|
|
export declare function modifyF<F extends URIS2>(
|
|
F: Applicative2<F>
|
|
): <A, E>(f: (a: A) => Kind2<F, E, A>) => <S>(sa: Optional<S, A>) => (s: S) => Kind2<F, E, S>
|
|
export declare function modifyF<F extends URIS>(
|
|
F: Applicative1<F>
|
|
): <A>(f: (a: A) => Kind<F, A>) => <S>(sa: Optional<S, A>) => (s: S) => Kind<F, S>
|
|
export declare function modifyF<F>(
|
|
F: Applicative<F>
|
|
): <A>(f: (a: A) => HKT<F, A>) => <S>(sa: Optional<S, A>) => (s: S) => HKT<F, S>
|
|
/**
|
|
* Return an `Optional` from a `Optional` focused on a nullable value.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.3
|
|
*/
|
|
export declare const fromNullable: <S, A>(sa: Optional<S, A>) => Optional<S, NonNullable<A>>
|
|
/**
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare function filter<A, B extends A>(refinement: Refinement<A, B>): <S>(sa: Optional<S, A>) => Optional<S, B>
|
|
export declare function filter<A>(predicate: Predicate<A>): <S>(sa: Optional<S, A>) => Optional<S, A>
|
|
/**
|
|
* Return a `Optional` from a `Optional` and a prop.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const prop: <A, P extends keyof A>(prop: P) => <S>(sa: Optional<S, A>) => Optional<S, A[P]>
|
|
/**
|
|
* Return a `Optional` from a `Optional` and a list of props.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const props: <A, P extends keyof A>(
|
|
props_0: P,
|
|
props_1: P,
|
|
...props_2: P[]
|
|
) => <S>(sa: Optional<S, A>) => Optional<S, { [K in P]: A[K] }>
|
|
/**
|
|
* Return a `Optional` from a `Optional` focused on a component of a tuple.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const component: <A extends readonly unknown[], P extends keyof A>(
|
|
prop: P
|
|
) => <S>(sa: Optional<S, A>) => Optional<S, A[P]>
|
|
/**
|
|
* Return a `Optional` from a `Optional` focused on an index of a `ReadonlyArray`.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const index: (i: number) => <S, A>(sa: Optional<S, ReadonlyArray<A>>) => Optional<S, A>
|
|
/**
|
|
* Return a `Optional` from a `Optional` focused on an index of a `ReadonlyNonEmptyArray`.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.8
|
|
*/
|
|
export declare const indexNonEmpty: (i: number) => <S, A>(sa: Optional<S, ReadonlyNonEmptyArray<A>>) => Optional<S, A>
|
|
/**
|
|
* Return a `Optional` from a `Optional` focused on a key of a `ReadonlyRecord`.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const key: (key: string) => <S, A>(sa: Optional<S, ReadonlyRecord<string, A>>) => Optional<S, A>
|
|
/**
|
|
* Return a `Optional` from a `Optional` focused on a required key of a `ReadonlyRecord`.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const atKey: (
|
|
key: string
|
|
) => <S, A>(sa: Optional<S, Readonly<Record<string, A>>>) => Optional<S, O.Option<A>>
|
|
/**
|
|
* Return a `Optional` from a `Optional` focused on the `Some` of a `Option` type.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const some: <S, A>(soa: Optional<S, Option<A>>) => Optional<S, A>
|
|
/**
|
|
* Return a `Optional` from a `Optional` focused on the `Right` of a `Either` type.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const right: <S, E, A>(sea: Optional<S, Either<E, A>>) => Optional<S, A>
|
|
/**
|
|
* Return a `Optional` from a `Optional` focused on the `Left` of a `Either` type.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const left: <S, E, A>(sea: Optional<S, Either<E, A>>) => Optional<S, E>
|
|
/**
|
|
* Return a `Traversal` from a `Optional` focused on a `Traversable`.
|
|
*
|
|
* @category combinators
|
|
* @since 2.3.0
|
|
*/
|
|
export declare function traverse<T extends URIS>(
|
|
T: Traversable1<T>
|
|
): <S, A>(sta: Optional<S, Kind<T, A>>) => Traversal<S, A>
|
|
/**
|
|
* @category combinators
|
|
* @since 2.3.2
|
|
*/
|
|
export declare function findFirst<A, B extends A>(
|
|
refinement: Refinement<A, B>
|
|
): <S>(sa: Optional<S, ReadonlyArray<A>>) => Optional<S, B>
|
|
export declare function findFirst<A>(predicate: Predicate<A>): <S>(sa: Optional<S, ReadonlyArray<A>>) => Optional<S, A>
|
|
/**
|
|
* @category combinators
|
|
* @since 2.3.8
|
|
*/
|
|
export declare function findFirstNonEmpty<A, B extends A>(
|
|
refinement: Refinement<A, B>
|
|
): <S>(sa: Optional<S, ReadonlyNonEmptyArray<A>>) => Optional<S, B>
|
|
export declare function findFirstNonEmpty<A>(
|
|
predicate: Predicate<A>
|
|
): <S>(sa: Optional<S, ReadonlyNonEmptyArray<A>>) => Optional<S, A>
|
|
/**
|
|
* @category Invariant
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const imap: <A, B>(f: (a: A) => B, g: (b: B) => A) => <E>(fa: Optional<E, A>) => Optional<E, B>
|
|
/**
|
|
* @category instances
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const URI = 'monocle-ts/Optional'
|
|
/**
|
|
* @category instances
|
|
* @since 2.3.0
|
|
*/
|
|
export declare type URI = typeof URI
|
|
declare module 'fp-ts/es6/HKT' {
|
|
interface URItoKind2<E, A> {
|
|
readonly [URI]: Optional<E, A>
|
|
}
|
|
}
|
|
/**
|
|
* @category instances
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const Invariant: Invariant2<URI>
|
|
/**
|
|
* @category instances
|
|
* @since 2.3.8
|
|
*/
|
|
export declare const Semigroupoid: Semigroupoid2<URI>
|
|
/**
|
|
* @category instances
|
|
* @since 2.3.0
|
|
*/
|
|
export declare const Category: Category2<URI>
|