fp-ts
Version:
Functional programming in TypeScript
573 lines (572 loc) • 16.2 kB
TypeScript
/**
* Data structure which represents non-empty arrays
*
* @since 2.5.0
*/
import { Alt1 } from './Alt'
import { Applicative1 } from './Applicative'
import { Comonad1 } from './Comonad'
import { Eq } from './Eq'
import { Foldable1 } from './Foldable'
import { FoldableWithIndex1 } from './FoldableWithIndex'
import { Lazy, Predicate, Refinement } from './function'
import { Functor1 } from './Functor'
import { FunctorWithIndex1 } from './FunctorWithIndex'
import { Monad1 } from './Monad'
import { Option } from './Option'
import { Ord } from './Ord'
import { ReadonlyRecord } from './ReadonlyRecord'
import { Semigroup } from './Semigroup'
import { Show } from './Show'
import { PipeableTraverse1, Traversable1 } from './Traversable'
import { PipeableTraverseWithIndex1, TraversableWithIndex1 } from './TraversableWithIndex'
/**
* @category model
* @since 2.5.0
*/
export declare type ReadonlyNonEmptyArray<A> = ReadonlyArray<A> & {
readonly 0: A
}
/**
* Append an element to the front of an array, creating a new non empty array
*
* @example
* import { cons } from 'fp-ts/ReadonlyNonEmptyArray'
*
* assert.deepStrictEqual(cons(1, [2, 3, 4]), [1, 2, 3, 4])
*
* @category constructors
* @since 2.5.0
*/
export declare const cons: <A>(head: A, tail: ReadonlyArray<A>) => ReadonlyNonEmptyArray<A>
/**
* Append an element to the end of an array, creating a new non empty array
*
* @example
* import { snoc } from 'fp-ts/ReadonlyNonEmptyArray'
*
* assert.deepStrictEqual(snoc([1, 2, 3], 4), [1, 2, 3, 4])
*
* @category constructors
* @since 2.5.0
*/
export declare const snoc: <A>(init: ReadonlyArray<A>, end: A) => ReadonlyNonEmptyArray<A>
/**
* Builds a `ReadonlyNonEmptyArray` from an array returning `none` if `as` is an empty array
*
* @category constructors
* @since 2.5.0
*/
export declare function fromReadonlyArray<A>(as: ReadonlyArray<A>): Option<ReadonlyNonEmptyArray<A>>
/**
* @category constructors
* @since 2.5.0
*/
export declare function fromArray<A>(as: Array<A>): Option<ReadonlyNonEmptyArray<A>>
/**
* Produces a couple of the first element of the array, and a new array of the remaining elements, if any
*
* @example
* import { cons, uncons } from 'fp-ts/ReadonlyNonEmptyArray'
*
* assert.deepStrictEqual(uncons(cons(1, [2, 3, 4])), [1, [2, 3, 4]])
*
* @category destructors
* @since 2.9.0
*/
export declare function uncons<A>(nea: ReadonlyNonEmptyArray<A>): readonly [A, ReadonlyArray<A>]
/**
* Produces a couple of a copy of the array without its last element, and that last element
*
* @example
* import { snoc, unsnoc } from 'fp-ts/ReadonlyNonEmptyArray'
*
* assert.deepStrictEqual(unsnoc(snoc([1, 2, 3], 4)), [[1, 2, 3], 4])
*
* @category destructors
* @since 2.9.0
*/
export declare function unsnoc<A>(nea: ReadonlyNonEmptyArray<A>): readonly [ReadonlyArray<A>, A]
/**
* @category instances
* @since 2.5.0
*/
export declare const getShow: <A>(S: Show<A>) => Show<ReadonlyNonEmptyArray<A>>
/**
* @since 2.5.0
*/
export declare function head<A>(nea: ReadonlyNonEmptyArray<A>): A
/**
* @since 2.5.0
*/
export declare function tail<A>(nea: ReadonlyNonEmptyArray<A>): ReadonlyArray<A>
/**
* @category combinators
* @since 2.5.0
*/
export declare const reverse: <A>(nea: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<A>
/**
* @since 2.5.0
*/
export declare function min<A>(ord: Ord<A>): (nea: ReadonlyNonEmptyArray<A>) => A
/**
* @since 2.5.0
*/
export declare function max<A>(ord: Ord<A>): (nea: ReadonlyNonEmptyArray<A>) => A
/**
* Builds a `Semigroup` instance for `ReadonlyNonEmptyArray`
*
* @category instances
* @since 2.5.0
*/
export declare function getSemigroup<A = never>(): Semigroup<ReadonlyNonEmptyArray<A>>
/**
* @example
* import { getEq, cons } from 'fp-ts/ReadonlyNonEmptyArray'
* import { eqNumber } from 'fp-ts/Eq'
*
* const E = getEq(eqNumber)
* assert.strictEqual(E.equals(cons(1, [2]), [1, 2]), true)
* assert.strictEqual(E.equals(cons(1, [2]), [1, 3]), false)
*
* @category instances
* @since 2.5.0
*/
export declare const getEq: <A>(E: Eq<A>) => Eq<ReadonlyNonEmptyArray<A>>
/**
* Group equal, consecutive elements of an array into non empty arrays.
*
* @example
* import { cons, group } from 'fp-ts/ReadonlyNonEmptyArray'
* import { ordNumber } from 'fp-ts/Ord'
*
* assert.deepStrictEqual(group(ordNumber)([1, 2, 1, 1]), [
* cons(1, []),
* cons(2, []),
* cons(1, [1])
* ])
*
* @category combinators
* @since 2.5.0
*/
export declare function group<B>(
E: Eq<B>
): {
<A extends B>(as: ReadonlyNonEmptyArray<A>): ReadonlyNonEmptyArray<ReadonlyNonEmptyArray<A>>
<A extends B>(as: ReadonlyArray<A>): ReadonlyArray<ReadonlyNonEmptyArray<A>>
}
/**
* Sort and then group the elements of an array into non empty arrays.
*
* @example
* import { cons, groupSort } from 'fp-ts/ReadonlyNonEmptyArray'
* import { ordNumber } from 'fp-ts/Ord'
*
* assert.deepStrictEqual(groupSort(ordNumber)([1, 2, 1, 1]), [cons(1, [1, 1]), cons(2, [])])
*
* @category combinators
* @since 2.5.0
*/
export declare function groupSort<B>(
O: Ord<B>
): {
<A extends B>(as: ReadonlyNonEmptyArray<A>): ReadonlyNonEmptyArray<ReadonlyNonEmptyArray<A>>
<A extends B>(as: ReadonlyArray<A>): ReadonlyArray<ReadonlyNonEmptyArray<A>>
}
/**
* Splits an array into sub-non-empty-arrays stored in an object, based on the result of calling a `string`-returning
* function on each element, and grouping the results according to values returned
*
* @example
* import { cons, groupBy } from 'fp-ts/ReadonlyNonEmptyArray'
*
* assert.deepStrictEqual(groupBy((s: string) => String(s.length))(['foo', 'bar', 'foobar']), {
* '3': cons('foo', ['bar']),
* '6': cons('foobar', [])
* })
*
* @category constructors
* @since 2.5.0
*/
export declare function groupBy<A>(
f: (a: A) => string
): (as: ReadonlyArray<A>) => ReadonlyRecord<string, ReadonlyNonEmptyArray<A>>
/**
* @since 2.5.0
*/
export declare function last<A>(nea: ReadonlyNonEmptyArray<A>): A
/**
* Get all but the last element of a non empty array, creating a new array.
*
* @example
* import { init } from 'fp-ts/ReadonlyNonEmptyArray'
*
* assert.deepStrictEqual(init([1, 2, 3]), [1, 2])
* assert.deepStrictEqual(init([1]), [])
*
* @since 2.5.0
*/
export declare function init<A>(nea: ReadonlyNonEmptyArray<A>): ReadonlyArray<A>
/**
* @category combinators
* @since 2.5.0
*/
export declare function sort<B>(O: Ord<B>): <A extends B>(nea: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<A>
/**
* @since 2.5.0
*/
export declare function insertAt<A>(
i: number,
a: A
): (nea: ReadonlyNonEmptyArray<A>) => Option<ReadonlyNonEmptyArray<A>>
/**
* @since 2.5.0
*/
export declare function updateAt<A>(
i: number,
a: A
): (nea: ReadonlyNonEmptyArray<A>) => Option<ReadonlyNonEmptyArray<A>>
/**
* @since 2.5.0
*/
export declare function modifyAt<A>(
i: number,
f: (a: A) => A
): (nea: ReadonlyNonEmptyArray<A>) => Option<ReadonlyNonEmptyArray<A>>
/**
* @since 2.5.0
*/
export declare function filter<A, B extends A>(
refinement: Refinement<A, B>
): (nea: ReadonlyNonEmptyArray<A>) => Option<ReadonlyNonEmptyArray<B>>
export declare function filter<A>(
predicate: Predicate<A>
): (nea: ReadonlyNonEmptyArray<A>) => Option<ReadonlyNonEmptyArray<A>>
/**
* @since 2.5.0
*/
export declare function filterWithIndex<A>(
predicate: (i: number, a: A) => boolean
): (nea: ReadonlyNonEmptyArray<A>) => Option<ReadonlyNonEmptyArray<A>>
/**
* Wrap a value into the type constructor.
*
* @category Applicative
* @since 2.5.0
*/
export declare const of: Applicative1<URI>['of']
/**
* @category constructors
* @since 2.5.0
*/
export declare function concat<A>(fx: ReadonlyArray<A>, fy: ReadonlyNonEmptyArray<A>): ReadonlyNonEmptyArray<A>
export declare function concat<A>(fx: ReadonlyNonEmptyArray<A>, fy: ReadonlyArray<A>): ReadonlyNonEmptyArray<A>
/**
* @since 2.5.0
*/
export declare function fold<A>(S: Semigroup<A>): (fa: ReadonlyNonEmptyArray<A>) => A
/**
* @category combinators
* @since 2.5.1
*/
export declare const zipWith: <A, B, C>(
fa: ReadonlyNonEmptyArray<A>,
fb: ReadonlyNonEmptyArray<B>,
f: (a: A, b: B) => C
) => ReadonlyNonEmptyArray<C>
/**
* @category combinators
* @since 2.5.1
*/
export declare const zip: {
<B>(bs: ReadonlyNonEmptyArray<B>): <A>(as: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<readonly [A, B]>
<A, B>(as: ReadonlyNonEmptyArray<A>, bs: ReadonlyNonEmptyArray<B>): ReadonlyNonEmptyArray<readonly [A, B]>
}
/**
* @since 2.5.1
*/
export declare const unzip: <A, B>(
as: ReadonlyNonEmptyArray<readonly [A, B]>
) => readonly [ReadonlyNonEmptyArray<A>, ReadonlyNonEmptyArray<B>]
/**
* Prepend an element to every member of an array
*
* @example
* import { cons, prependToAll } from 'fp-ts/ReadonlyNonEmptyArray'
*
* assert.deepStrictEqual(prependToAll(9)(cons(1, [2, 3, 4])), cons(9, [1, 9, 2, 9, 3, 9, 4]))
*
* @category combinators
* @since 2.9.0
*/
export declare const prependToAll: <A>(e: A) => (xs: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<A>
/**
* Places an element in between members of an array
*
* @example
* import { cons, intersperse } from 'fp-ts/ReadonlyNonEmptyArray'
*
* assert.deepStrictEqual(intersperse(9)(cons(1, [2, 3, 4])), cons(1, [9, 2, 9, 3, 9, 4]))
*
* @category combinators
* @since 2.9.0
*/
export declare const intersperse: <A>(e: A) => (as: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<A>
/**
* @category FoldableWithIndex
* @since 2.5.0
*/
export declare const foldMapWithIndex: <S>(
S: Semigroup<S>
) => <A>(f: (i: number, a: A) => S) => (fa: ReadonlyNonEmptyArray<A>) => S
/**
* @category Foldable
* @since 2.5.0
*/
export declare const foldMap: <S>(S: Semigroup<S>) => <A>(f: (a: A) => S) => (fa: ReadonlyNonEmptyArray<A>) => S
/**
* Less strict version of [`alt`](#alt).
*
* @category Alt
* @since 2.9.0
*/
export declare const altW: <B>(
that: Lazy<ReadonlyNonEmptyArray<B>>
) => <A>(fa: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<A | B>
/**
* Identifies an associative operation on a type constructor. It is similar to `Semigroup`, except that it applies to
* types of kind `* -> *`.
*
* @category Alt
* @since 2.6.2
*/
export declare const alt: <A>(
that: Lazy<ReadonlyNonEmptyArray<A>>
) => (fa: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<A>
/**
* @category Apply
* @since 2.5.0
*/
export declare const ap: <A>(
fa: ReadonlyNonEmptyArray<A>
) => <B>(fab: ReadonlyNonEmptyArray<(a: A) => B>) => ReadonlyNonEmptyArray<B>
/**
* Combine two effectful actions, keeping only the result of the first.
*
* Derivable from `Apply`.
*
* @category combinators
* @since 2.5.0
*/
export declare const apFirst: <B>(
fb: ReadonlyNonEmptyArray<B>
) => <A>(fa: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<A>
/**
* Combine two effectful actions, keeping only the result of the second.
*
* Derivable from `Apply`.
*
* @category combinators
* @since 2.5.0
*/
export declare const apSecond: <B>(
fb: ReadonlyNonEmptyArray<B>
) => <A>(fa: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<B>
/**
* Composes computations in sequence, using the return value of one computation to determine the next computation.
*
* @category Monad
* @since 2.5.0
*/
export declare const chain: <A, B>(
f: (a: A) => ReadonlyNonEmptyArray<B>
) => (ma: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<B>
/**
* Composes computations in sequence, using the return value of one computation to determine the next computation and
* keeping only the result of the first.
*
* Derivable from `Monad`.
*
* @category combinators
* @since 2.5.0
*/
export declare const chainFirst: <A, B>(
f: (a: A) => ReadonlyNonEmptyArray<B>
) => (ma: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<A>
/**
* Derivable from `Extend`.
*
* @category combinators
* @since 2.5.0
*/
export declare const duplicate: <A>(ma: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<ReadonlyNonEmptyArray<A>>
/**
* @category Extend
* @since 2.5.0
*/
export declare const extend: <A, B>(
f: (fa: ReadonlyNonEmptyArray<A>) => B
) => (ma: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<B>
/**
* Derivable from `Monad`.
*
* @category combinators
* @since 2.5.0
*/
export declare const flatten: <A>(mma: ReadonlyNonEmptyArray<ReadonlyNonEmptyArray<A>>) => ReadonlyNonEmptyArray<A>
/**
* `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.
*
* @category Functor
* @since 2.5.0
*/
export declare const map: <A, B>(f: (a: A) => B) => (fa: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<B>
/**
* @category FunctorWithIndex
* @since 2.5.0
*/
export declare const mapWithIndex: <A, B>(
f: (i: number, a: A) => B
) => (fa: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<B>
/**
* @category Foldable
* @since 2.5.0
*/
export declare const reduce: <A, B>(b: B, f: (b: B, a: A) => B) => (fa: ReadonlyNonEmptyArray<A>) => B
/**
* @category FoldableWithIndex
* @since 2.5.0
*/
export declare const reduceWithIndex: <A, B>(
b: B,
f: (i: number, b: B, a: A) => B
) => (fa: ReadonlyNonEmptyArray<A>) => B
/**
* @category Foldable
* @since 2.5.0
*/
export declare const reduceRight: <A, B>(b: B, f: (a: A, b: B) => B) => (fa: ReadonlyNonEmptyArray<A>) => B
/**
* @category FoldableWithIndex
* @since 2.5.0
*/
export declare const reduceRightWithIndex: <A, B>(
b: B,
f: (i: number, a: A, b: B) => B
) => (fa: ReadonlyNonEmptyArray<A>) => B
/**
* @since 2.6.3
*/
export declare const traverse: PipeableTraverse1<URI>
/**
* @since 2.6.3
*/
export declare const sequence: Traversable1<URI>['sequence']
/**
* @since 2.6.3
*/
export declare const traverseWithIndex: PipeableTraverseWithIndex1<URI, number>
/**
* @since 2.6.3
*/
export declare const extract: Comonad1<URI>['extract']
/**
* @category instances
* @since 2.5.0
*/
export declare const URI = 'ReadonlyNonEmptyArray'
/**
* @category instances
* @since 2.5.0
*/
export declare type URI = typeof URI
declare module './HKT' {
interface URItoKind<A> {
readonly [URI]: ReadonlyNonEmptyArray<A>
}
}
/**
* @category instances
* @since 2.7.0
*/
export declare const Functor: Functor1<URI>
/**
* @category instances
* @since 2.7.0
*/
export declare const FunctorWithIndex: FunctorWithIndex1<URI, number>
/**
* @category instances
* @since 2.7.0
*/
export declare const Applicative: Applicative1<URI>
/**
* @category instances
* @since 2.7.0
*/
export declare const Monad: Monad1<URI>
/**
* @category instances
* @since 2.7.0
*/
export declare const Foldable: Foldable1<URI>
/**
* @category instances
* @since 2.7.0
*/
export declare const FoldableWithIndex: FoldableWithIndex1<URI, number>
/**
* @category instances
* @since 2.7.0
*/
export declare const Traversable: Traversable1<URI>
/**
* @category instances
* @since 2.7.0
*/
export declare const TraversableWithIndex: TraversableWithIndex1<URI, number>
/**
* @category instances
* @since 2.7.0
*/
export declare const Alt: Alt1<URI>
/**
* @category instances
* @since 2.7.0
*/
export declare const Comonad: Comonad1<URI>
/**
* @category instances
* @since 2.5.0
*/
export declare const readonlyNonEmptyArray: Monad1<URI> &
Comonad1<URI> &
TraversableWithIndex1<URI, number> &
FunctorWithIndex1<URI, number> &
FoldableWithIndex1<URI, number> &
Alt1<URI>
/**
* @since 2.9.0
*/
export declare const Do: ReadonlyNonEmptyArray<{}>
/**
* @since 2.8.0
*/
export declare const bindTo: <N extends string>(
name: N
) => <A>(fa: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<{ [K in N]: A }>
/**
* @since 2.8.0
*/
export declare const bind: <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => ReadonlyNonEmptyArray<B>
) => (fa: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<{ [K in N | keyof A]: K extends keyof A ? A[K] : B }>
/**
* @since 2.8.0
*/
export declare const apS: <A, N extends string, B>(
name: Exclude<N, keyof A>,
fb: ReadonlyNonEmptyArray<B>
) => (fa: ReadonlyNonEmptyArray<A>) => ReadonlyNonEmptyArray<{ [K in N | keyof A]: K extends keyof A ? A[K] : B }>