/** * Data structure which represents non-empty arrays. * * ```ts * export type NonEmptyArray = Array & { * 0: A * } * ``` * * Note that you don't need any conversion, a `NonEmptyArray` is an `Array`, * so all `Array`'s APIs can be used with a `NonEmptyArray` without further ado. * * @since 2.0.0 */ import { Alt1 } from './Alt' import { Applicative1 } from './Applicative' import { Apply1 } from './Apply' import { Chain1 } from './Chain' import { Comonad1 } from './Comonad' import { Endomorphism } from './Endomorphism' import { Eq } from './Eq' import { Foldable1 } from './Foldable' import { FoldableWithIndex1 } from './FoldableWithIndex' import { Lazy } from './function' import { Functor1 } from './Functor' import { FunctorWithIndex1 } from './FunctorWithIndex' import { Monad1 } from './Monad' import { Option } from './Option' import { Ord } from './Ord' import { Pointed1 } from './Pointed' import { Predicate } from './Predicate' import * as RNEA from './ReadonlyNonEmptyArray' import { Refinement } from './Refinement' import * as Se from './Semigroup' import { Show } from './Show' import { PipeableTraverse1, Traversable1 } from './Traversable' import { PipeableTraverseWithIndex1, TraversableWithIndex1 } from './TraversableWithIndex' import Semigroup = Se.Semigroup import ReadonlyNonEmptyArray = RNEA.ReadonlyNonEmptyArray /** * @category model * @since 2.0.0 */ export interface NonEmptyArray extends Array { 0: A } /** * Remove duplicates from a `NonEmptyArray`, keeping the first occurrence of an element. * * @example * import { uniq } from 'fp-ts/NonEmptyArray' * import * as N from 'fp-ts/number' * * assert.deepStrictEqual(uniq(N.Eq)([1, 2, 1]), [1, 2]) * * @since 2.11.0 */ export declare const uniq: (E: Eq) => (as: NonEmptyArray) => NonEmptyArray /** * Sort the elements of a `NonEmptyArray` in increasing order, where elements are compared using first `ords[0]`, then `ords[1]`, * etc... * * @example * import * as NEA from 'fp-ts/NonEmptyArray' * import { contramap } from 'fp-ts/Ord' * import * as S from 'fp-ts/string' * import * as N from 'fp-ts/number' * import { pipe } from 'fp-ts/function' * * interface Person { * name: string * age: number * } * * const byName = pipe(S.Ord, contramap((p: Person) => p.name)) * * const byAge = pipe(N.Ord, contramap((p: Person) => p.age)) * * const sortByNameByAge = NEA.sortBy([byName, byAge]) * * const persons: NEA.NonEmptyArray = [ * { name: 'a', age: 1 }, * { name: 'b', age: 3 }, * { name: 'c', age: 2 }, * { name: 'b', age: 2 } * ] * * assert.deepStrictEqual(sortByNameByAge(persons), [ * { name: 'a', age: 1 }, * { name: 'b', age: 2 }, * { name: 'b', age: 3 }, * { name: 'c', age: 2 } * ]) * * @since 2.11.0 */ export declare const sortBy: (ords: Ord[]) => (as: NonEmptyArray) => NonEmptyArray /** * @since 2.11.0 */ export declare const union: (E: Eq) => (second: NonEmptyArray) => (first: NonEmptyArray) => NonEmptyArray /** * Rotate a `NonEmptyArray` by `n` steps. * * @example * import { rotate } from 'fp-ts/NonEmptyArray' * * assert.deepStrictEqual(rotate(2)([1, 2, 3, 4, 5]), [4, 5, 1, 2, 3]) * assert.deepStrictEqual(rotate(-2)([1, 2, 3, 4, 5]), [3, 4, 5, 1, 2]) * * @since 2.11.0 */ export declare const rotate: (n: number) => (as: NonEmptyArray) => NonEmptyArray /** * @category conversions * @since 2.10.0 */ export declare const fromReadonlyNonEmptyArray: (as: ReadonlyNonEmptyArray) => NonEmptyArray /** * Builds a `NonEmptyArray` from an `Array` returning `none` if `as` is an empty array * * @category conversions * @since 2.0.0 */ export declare const fromArray: (as: A[]) => Option> /** * Return a `NonEmptyArray` of length `n` with element `i` initialized with `f(i)`. * * **Note**. `n` is normalized to a natural number. * * @example * import { makeBy } from 'fp-ts/NonEmptyArray' * import { pipe } from 'fp-ts/function' * * const double = (n: number): number => n * 2 * assert.deepStrictEqual(pipe(5, makeBy(double)), [0, 2, 4, 6, 8]) * * @category constructors * @since 2.11.0 */ export declare const makeBy: (f: (i: number) => A) => (n: number) => NonEmptyArray /** * Create a `NonEmptyArray` containing a value repeated the specified number of times. * * **Note**. `n` is normalized to a natural number. * * @example * import { replicate } from 'fp-ts/NonEmptyArray' * import { pipe } from 'fp-ts/function' * * assert.deepStrictEqual(pipe(3, replicate('a')), ['a', 'a', 'a']) * * @category constructors * @since 2.11.0 */ export declare const replicate: (a: A) => (n: number) => RNEA.ReadonlyNonEmptyArray /** * Create a `NonEmptyArray` containing a range of integers, including both endpoints. * * @example * import { range } from 'fp-ts/NonEmptyArray' * * assert.deepStrictEqual(range(1, 5), [1, 2, 3, 4, 5]) * * @category constructors * @since 2.11.0 */ export declare const range: (start: number, end: number) => NonEmptyArray /** * Return the tuple of the `head` and the `tail`. * * @example * import { unprepend } from 'fp-ts/NonEmptyArray' * * assert.deepStrictEqual(unprepend([1, 2, 3]), [1, [2, 3]]) * * @since 2.9.0 */ export declare const unprepend: (as: NonEmptyArray) => [A, A[]] /** * Return the tuple of the `init` and the `last`. * * @example * import { unappend } from 'fp-ts/NonEmptyArray' * * assert.deepStrictEqual(unappend([1, 2, 3, 4]), [[1, 2, 3], 4]) * * @since 2.9.0 */ export declare const unappend: (as: NonEmptyArray) => [A[], A] /** * @since 2.11.0 */ export declare function concatW(second: NonEmptyArray): (first: Array) => NonEmptyArray export declare function concatW(second: Array): (first: NonEmptyArray) => NonEmptyArray /** * @since 2.2.0 */ export declare function concat(second: NonEmptyArray): (first: Array) => NonEmptyArray export declare function concat(second: Array): (first: NonEmptyArray) => NonEmptyArray /** @deprecated */ export declare function concat(first: Array, second: NonEmptyArray): NonEmptyArray /** @deprecated */ export declare function concat(first: NonEmptyArray, second: Array): NonEmptyArray /** * @since 2.0.0 */ export declare const reverse: (as: NonEmptyArray) => NonEmptyArray /** * Group equal, consecutive elements of an array into non empty arrays. * * @example * import { group } from 'fp-ts/NonEmptyArray' * import * as N from 'fp-ts/number' * * assert.deepStrictEqual(group(N.Ord)([1, 2, 1, 1]), [ * [1], * [2], * [1, 1] * ]) * * @since 2.0.0 */ export declare function group(E: Eq): { (as: NonEmptyArray): NonEmptyArray> (as: Array): Array> } /** * 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 { groupBy } from 'fp-ts/NonEmptyArray' * * assert.deepStrictEqual(groupBy((s: string) => String(s.length))(['a', 'b', 'ab']), { * '1': ['a', 'b'], * '2': ['ab'] * }) * * @since 2.0.0 */ export declare const groupBy: (f: (a: A) => string) => (as: A[]) => Record> /** * @since 2.0.0 */ export declare const sort: (O: Ord) => (as: NonEmptyArray) => NonEmptyArray /** * @since 2.0.0 */ export declare const insertAt: (i: number, a: A) => (as: A[]) => Option> /** * @since 2.0.0 */ export declare const updateAt: (i: number, a: A) => (as: NonEmptyArray) => Option> /** * @since 2.0.0 */ export declare const modifyAt: (i: number, f: (a: A) => A) => (as: NonEmptyArray) => Option> /** * @since 2.0.0 */ export declare const copy: (as: NonEmptyArray) => NonEmptyArray /** * @category constructors * @since 2.0.0 */ export declare const of: (a: A) => NonEmptyArray /** * @since 2.5.1 */ export declare const zipWith: ( as: NonEmptyArray, bs: NonEmptyArray, f: (a: A, b: B) => C ) => NonEmptyArray /** * @since 2.5.1 */ export declare function zip(bs: NonEmptyArray): (as: NonEmptyArray) => NonEmptyArray<[A, B]> export declare function zip(as: NonEmptyArray, bs: NonEmptyArray): NonEmptyArray<[A, B]> /** * @since 2.5.1 */ export declare const unzip: (abs: NonEmptyArray<[A, B]>) => [NonEmptyArray, NonEmptyArray] /** * Prepend an element to every member of an array * * @example * import { prependAll } from 'fp-ts/NonEmptyArray' * * assert.deepStrictEqual(prependAll(9)([1, 2, 3, 4]), [9, 1, 9, 2, 9, 3, 9, 4]) * * @since 2.10.0 */ export declare const prependAll: (middle: A) => (as: NonEmptyArray) => NonEmptyArray /** * Places an element in between members of an array * * @example * import { intersperse } from 'fp-ts/NonEmptyArray' * * assert.deepStrictEqual(intersperse(9)([1, 2, 3, 4]), [1, 9, 2, 9, 3, 9, 4]) * * @since 2.9.0 */ export declare const intersperse: (middle: A) => (as: NonEmptyArray) => NonEmptyArray /** * @category folding * @since 2.0.0 */ export declare const foldMapWithIndex: ( S: Semigroup ) => (f: (i: number, a: A) => S) => (fa: NonEmptyArray) => S /** * @category folding * @since 2.0.0 */ export declare const foldMap: (S: Semigroup) => (f: (a: A) => S) => (fa: NonEmptyArray) => S /** * @category sequencing * @since 2.10.0 */ export declare const chainWithIndex: ( f: (i: number, a: A) => NonEmptyArray ) => (as: NonEmptyArray) => NonEmptyArray /** * @since 2.10.0 */ export declare const chop: (f: (as: NonEmptyArray) => [B, A[]]) => (as: NonEmptyArray) => NonEmptyArray /** * Splits a `NonEmptyArray` into two pieces, the first piece has max `n` elements. * * @since 2.10.0 */ export declare const splitAt: (n: number) => (as: NonEmptyArray) => [NonEmptyArray, A[]] /** * @since 2.10.0 */ export declare const chunksOf: (n: number) => (as: NonEmptyArray) => NonEmptyArray> /** * Less strict version of [`alt`](#alt). * * The `W` suffix (short for **W**idening) means that the return types will be merged. * * @example * import * as NEA from 'fp-ts/NonEmptyArray' * import { pipe } from 'fp-ts/function' * * assert.deepStrictEqual( * pipe( * [1, 2, 3] as NEA.NonEmptyArray, * NEA.altW(() => ['a', 'b']) * ), * [1, 2, 3, 'a', 'b'] * ) * * @category error handling * @since 2.9.0 */ export declare const altW: (that: Lazy>) => (as: NonEmptyArray) => NonEmptyArray /** * Identifies an associative operation on a type constructor. It is similar to `Semigroup`, except that it applies to * types of kind `* -> *`. * * In case of `NonEmptyArray` concatenates the inputs into a single array. * * @example * import * as NEA from 'fp-ts/NonEmptyArray' * import { pipe } from 'fp-ts/function' * * assert.deepStrictEqual( * pipe( * [1, 2, 3], * NEA.alt(() => [4, 5]) * ), * [1, 2, 3, 4, 5] * ) * * @category error handling * @since 2.6.2 */ export declare const alt: (that: Lazy>) => (fa: NonEmptyArray) => NonEmptyArray /** * Apply a function to an argument under a type constructor. * * @since 2.0.0 */ export declare const ap: (as: NonEmptyArray) => (fab: NonEmptyArray<(a: A) => B>) => NonEmptyArray /** * Composes computations in sequence, using the return value of one computation to determine the next computation. * * @example * import * as NEA from 'fp-ts/NonEmptyArray' * import { pipe } from 'fp-ts/function' * * assert.deepStrictEqual( * pipe( * [1, 2, 3], * NEA.chain((n) => [`a${n}`, `b${n}`]) * ), * ['a1', 'b1', 'a2', 'b2', 'a3', 'b3'] * ) * * @category sequencing * @since 2.0.0 */ export declare const chain: (f: (a: A) => NonEmptyArray) => (ma: NonEmptyArray) => NonEmptyArray /** * @since 2.0.0 */ export declare const extend: (f: (as: NonEmptyArray) => B) => (as: NonEmptyArray) => NonEmptyArray /** * @since 2.5.0 */ export declare const duplicate: (ma: NonEmptyArray) => NonEmptyArray> /** * @category sequencing * @since 2.5.0 */ export declare const flatten: (mma: NonEmptyArray>) => NonEmptyArray /** * `map` can be used to turn functions `(a: A) => B` into functions `(fa: F) => F` whose argument and return types * use the type constructor `F` to represent some computational context. * * @category mapping * @since 2.0.0 */ export declare const map: (f: (a: A) => B) => (as: NonEmptyArray) => NonEmptyArray /** * @category mapping * @since 2.0.0 */ export declare const mapWithIndex: (f: (i: number, a: A) => B) => (as: NonEmptyArray) => NonEmptyArray /** * @category folding * @since 2.0.0 */ export declare const reduce: (b: B, f: (b: B, a: A) => B) => (fa: NonEmptyArray) => B /** * @category folding * @since 2.0.0 */ export declare const reduceWithIndex: (b: B, f: (i: number, b: B, a: A) => B) => (fa: NonEmptyArray) => B /** * @category folding * @since 2.0.0 */ export declare const reduceRight: (b: B, f: (a: A, b: B) => B) => (fa: NonEmptyArray) => B /** * @category folding * @since 2.0.0 */ export declare const reduceRightWithIndex: (b: B, f: (i: number, a: A, b: B) => B) => (fa: NonEmptyArray) => B /** * @category traversing * @since 2.6.3 */ export declare const traverse: PipeableTraverse1 /** * @category traversing * @since 2.6.3 */ export declare const sequence: Traversable1['sequence'] /** * @category sequencing * @since 2.6.3 */ export declare const traverseWithIndex: PipeableTraverseWithIndex1 /** * @since 2.7.0 */ export declare const extract: Comonad1['extract'] /** * @category type lambdas * @since 2.0.0 */ export declare const URI = 'NonEmptyArray' /** * @category type lambdas * @since 2.0.0 */ export declare type URI = typeof URI declare module './HKT' { interface URItoKind { readonly [URI]: NonEmptyArray } } /** * @category instances * @since 2.0.0 */ export declare const getShow: (S: Show) => Show> /** * Builds a `Semigroup` instance for `NonEmptyArray` * * @category instances * @since 2.0.0 */ export declare const getSemigroup: () => Se.Semigroup> /** * @example * import { getEq } from 'fp-ts/NonEmptyArray' * import * as N from 'fp-ts/number' * * const E = getEq(N.Eq) * assert.strictEqual(E.equals([1, 2], [1, 2]), true) * assert.strictEqual(E.equals([1, 2], [1, 3]), false) * * @category instances * @since 2.0.0 */ export declare const getEq: (E: Eq) => Eq> /** * @since 2.11.0 */ export declare const getUnionSemigroup: (E: Eq) => Se.Semigroup> /** * @category instances * @since 2.7.0 */ export declare const Functor: Functor1 /** * @category mapping * @since 2.10.0 */ export declare const flap: (a: A) => (fab: NonEmptyArray<(a: A) => B>) => NonEmptyArray /** * @category instances * @since 2.10.0 */ export declare const Pointed: Pointed1 /** * @category instances * @since 2.7.0 */ export declare const FunctorWithIndex: FunctorWithIndex1 /** * @category instances * @since 2.10.0 */ export declare const Apply: Apply1 /** * Combine two effectful actions, keeping only the result of the first. * * @since 2.5.0 */ export declare const apFirst: (second: NonEmptyArray) => (first: NonEmptyArray) => NonEmptyArray /** * Combine two effectful actions, keeping only the result of the second. * * @since 2.5.0 */ export declare const apSecond: (second: NonEmptyArray) => (first: NonEmptyArray) => NonEmptyArray /** * @category instances * @since 2.7.0 */ export declare const Applicative: Applicative1 /** * @category instances * @since 2.10.0 */ export declare const Chain: Chain1 /** * Composes computations in sequence, using the return value of one computation to determine the next computation and * keeping only the result of the first. * * @category sequencing * @since 2.5.0 */ export declare const chainFirst: (f: (a: A) => NonEmptyArray) => (first: NonEmptyArray) => NonEmptyArray /** * @category instances * @since 2.7.0 */ export declare const Monad: Monad1 /** * @category instances * @since 2.7.0 */ export declare const Foldable: Foldable1 /** * @category instances * @since 2.7.0 */ export declare const FoldableWithIndex: FoldableWithIndex1 /** * @category instances * @since 2.7.0 */ export declare const Traversable: Traversable1 /** * @category instances * @since 2.7.0 */ export declare const TraversableWithIndex: TraversableWithIndex1 /** * @category instances * @since 2.7.0 */ export declare const Alt: Alt1 /** * @category instances * @since 2.7.0 */ export declare const Comonad: Comonad1 /** * @category do notation * @since 2.9.0 */ export declare const Do: NonEmptyArray<{}> /** * @category do notation * @since 2.8.0 */ export declare const bindTo: ( name: N ) => (fa: NonEmptyArray) => NonEmptyArray<{ readonly [K in N]: A }> declare const let_: ( name: Exclude, f: (a: A) => B ) => (fa: NonEmptyArray) => NonEmptyArray<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }> export { /** * @category do notation * @since 2.13.0 */ let_ as let } /** * @category do notation * @since 2.8.0 */ export declare const bind: ( name: Exclude, f: (a: A) => NonEmptyArray ) => (ma: NonEmptyArray) => NonEmptyArray<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }> /** * @category do notation * @since 2.8.0 */ export declare const apS: ( name: Exclude, fb: NonEmptyArray ) => (fa: NonEmptyArray) => NonEmptyArray<{ readonly [K in N | keyof A]: K extends keyof A ? A[K] : B }> /** * @since 2.0.0 */ export declare const head: (nea: NonEmptyArray) => A /** * @since 2.0.0 */ export declare const tail: (as: NonEmptyArray) => A[] /** * @since 2.0.0 */ export declare const last: (nea: NonEmptyArray) => A /** * Get all but the last element of a non empty array, creating a new array. * * @example * import { init } from 'fp-ts/NonEmptyArray' * * assert.deepStrictEqual(init([1, 2, 3]), [1, 2]) * assert.deepStrictEqual(init([1]), []) * * @since 2.2.0 */ export declare const init: (as: NonEmptyArray) => A[] /** * @since 2.0.0 */ export declare const min: (ord: Ord) => (nea: NonEmptyArray) => A /** * @since 2.0.0 */ export declare const max: (ord: Ord) => (nea: NonEmptyArray) => A /** * @since 2.10.0 */ export declare const concatAll: (S: Se.Semigroup) => (as: NonEmptyArray) => A /** * Break an `Array` into its first element and remaining elements. * * @category pattern matching * @since 2.11.0 */ export declare const matchLeft: (f: (head: A, tail: A[]) => B) => (as: NonEmptyArray) => B /** * Break an `Array` into its initial elements and the last element. * * @category pattern matching * @since 2.11.0 */ export declare const matchRight: (f: (init: A[], last: A) => B) => (as: NonEmptyArray) => B /** * Apply a function to the head, creating a new `NonEmptyArray`. * * @since 2.11.0 */ export declare const modifyHead: (f: Endomorphism) => (as: NonEmptyArray) => NonEmptyArray /** * Change the head, creating a new `NonEmptyArray`. * * @since 2.11.0 */ export declare const updateHead: (a: A) => (as: NonEmptyArray) => NonEmptyArray /** * Apply a function to the last element, creating a new `NonEmptyArray`. * * @since 2.11.0 */ export declare const modifyLast: (f: Endomorphism) => (as: NonEmptyArray) => NonEmptyArray /** * Change the last element, creating a new `NonEmptyArray`. * * @since 2.11.0 */ export declare const updateLast: (a: A) => (as: NonEmptyArray) => NonEmptyArray /** * Places an element in between members of a `NonEmptyArray`, then folds the results using the provided `Semigroup`. * * @example * import * as S from 'fp-ts/string' * import { intercalate } from 'fp-ts/NonEmptyArray' * * assert.deepStrictEqual(intercalate(S.Semigroup)('-')(['a', 'b', 'c']), 'a-b-c') * * @since 2.12.0 */ export declare const intercalate: (S: Semigroup) => (middle: A) => (as: NonEmptyArray) => A /** * This is just `sort` followed by `group`. * * @category zone of death * @since 2.0.0 * @deprecated */ export declare function groupSort(O: Ord): { (as: NonEmptyArray): NonEmptyArray> (as: Array): Array> } /** * Use [`filter`](./Array.ts.html#filter) instead. * * @category zone of death * @since 2.0.0 * @deprecated */ export declare function filter( refinement: Refinement ): (as: NonEmptyArray) => Option> export declare function filter( predicate: Predicate ): (bs: NonEmptyArray) => Option> export declare function filter(predicate: Predicate): (as: NonEmptyArray) => Option> /** * Use [`filterWithIndex`](./Array.ts.html#filterwithindex) instead. * * @category zone of death * @since 2.0.0 * @deprecated */ export declare const filterWithIndex: ( predicate: (i: number, a: A) => boolean ) => (as: NonEmptyArray) => Option> /** * Use [`unprepend`](#unprepend) instead. * * @category zone of death * @since 2.9.0 * @deprecated */ export declare const uncons: (as: NonEmptyArray) => [A, Array] /** * Use [`unappend`](#unappend) instead. * * @category zone of death * @since 2.9.0 * @deprecated */ export declare const unsnoc: (as: NonEmptyArray) => [Array, A] /** * Use [`prepend`](./Array.ts.html#prepend) instead. * * @category zone of death * @since 2.0.0 * @deprecated */ export declare function cons(head: A): (tail: Array) => NonEmptyArray /** @deprecated */ export declare function cons(head: A, tail: Array): NonEmptyArray /** * Use [`append`](./Array.ts.html#append) instead. * * @category zone of death * @since 2.0.0 * @deprecated */ export declare const snoc: (init: A[], end: A) => NonEmptyArray /** * Use [`prependAll`](#prependall) instead. * * @category zone of death * @since 2.9.0 * @deprecated */ export declare const prependToAll: (middle: A) => (as: NonEmptyArray) => NonEmptyArray /** * Use [`concatAll`](#concatall) instead. * * @category zone of death * @since 2.5.0 * @deprecated */ export declare const fold: (S: Semigroup) => (fa: NonEmptyArray) => A /** * This instance is deprecated, use small, specific instances instead. * For example if a function needs a `Functor` instance, pass `NEA.Functor` instead of `NEA.nonEmptyArray` * (where `NEA` is from `import NEA from 'fp-ts/NonEmptyArray'`) * * @category zone of death * @since 2.0.0 * @deprecated */ export declare const nonEmptyArray: Monad1 & Comonad1 & TraversableWithIndex1 & FunctorWithIndex1 & FoldableWithIndex1 & Alt1