title | nav_order | parent |
---|---|---|
NonEmptyArray.ts |
56 |
Modules |
Data structure which represents non-empty arrays
Added in v2.0.0
- Alt
- Applicative
- Apply
- Extend
- Foldable
- FoldableWithIndex
- Functor
- FunctorWithIndex
- Monad
- combinators
- constructors
- destructors
- instances
- model
- utils
Identifies an associative operation on a type constructor. It is similar to Semigroup
, except that it applies to
types of kind * -> *
.
Signature
export declare const alt: <A>(that: Lazy<NonEmptyArray<A>>) => (fa: NonEmptyArray<A>) => NonEmptyArray<A>
Added in v2.6.2
Less strict version of alt
.
Signature
export declare const altW: <B>(that: Lazy<NonEmptyArray<B>>) => <A>(fa: NonEmptyArray<A>) => NonEmptyArray<B | A>
Added in v2.9.0
Wrap a value into the type constructor.
Signature
export declare const of: <A>(a: A) => NonEmptyArray<A>
Added in v2.0.0
Apply a function to an argument under a type constructor.
Signature
export declare const ap: <A>(fa: NonEmptyArray<A>) => <B>(fab: NonEmptyArray<(a: A) => B>) => NonEmptyArray<B>
Added in v2.0.0
Signature
export declare const extend: <A, B>(f: (fa: NonEmptyArray<A>) => B) => (ma: NonEmptyArray<A>) => NonEmptyArray<B>
Added in v2.0.0
Signature
export declare const foldMap: <S>(S: Semigroup<S>) => <A>(f: (a: A) => S) => (fa: NonEmptyArray<A>) => S
Added in v2.0.0
Signature
export declare const reduce: <A, B>(b: B, f: (b: B, a: A) => B) => (fa: NonEmptyArray<A>) => B
Added in v2.0.0
Signature
export declare const reduceRight: <A, B>(b: B, f: (a: A, b: B) => B) => (fa: NonEmptyArray<A>) => B
Added in v2.0.0
Signature
export declare const foldMapWithIndex: <S>(
S: Semigroup<S>
) => <A>(f: (i: number, a: A) => S) => (fa: NonEmptyArray<A>) => S
Added in v2.0.0
Signature
export declare const reduceRightWithIndex: <A, B>(b: B, f: (i: number, a: A, b: B) => B) => (fa: NonEmptyArray<A>) => B
Added in v2.0.0
Signature
export declare const reduceWithIndex: <A, B>(b: B, f: (i: number, b: B, a: A) => B) => (fa: NonEmptyArray<A>) => B
Added in v2.0.0
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.
Signature
export declare const map: <A, B>(f: (a: A) => B) => (fa: NonEmptyArray<A>) => NonEmptyArray<B>
Added in v2.0.0
Signature
export declare const mapWithIndex: <A, B>(f: (i: number, a: A) => B) => (fa: NonEmptyArray<A>) => NonEmptyArray<B>
Added in v2.0.0
Composes computations in sequence, using the return value of one computation to determine the next computation.
Signature
export declare const chain: <A, B>(f: (a: A) => NonEmptyArray<B>) => (ma: NonEmptyArray<A>) => NonEmptyArray<B>
Added in v2.0.0
Combine two effectful actions, keeping only the result of the first.
Derivable from Apply
.
Signature
export declare const apFirst: <B>(fb: NonEmptyArray<B>) => <A>(fa: NonEmptyArray<A>) => NonEmptyArray<A>
Added in v2.0.0
Combine two effectful actions, keeping only the result of the second.
Derivable from Apply
.
Signature
export declare const apSecond: <B>(fb: NonEmptyArray<B>) => <A>(fa: NonEmptyArray<A>) => NonEmptyArray<B>
Added in v2.0.0
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
.
Signature
export declare const chainFirst: <A, B>(f: (a: A) => NonEmptyArray<B>) => (ma: NonEmptyArray<A>) => NonEmptyArray<A>
Added in v2.0.0
Signature
export declare function copy<A>(nea: NonEmptyArray<A>): NonEmptyArray<A>
Added in v2.0.0
Derivable from Extend
.
Signature
export declare const duplicate: <A>(ma: NonEmptyArray<A>) => NonEmptyArray<NonEmptyArray<A>>
Added in v2.0.0
Signature
export declare function filter<A, B extends A>(
refinement: Refinement<A, B>
): (nea: NonEmptyArray<A>) => Option<NonEmptyArray<B>>
export declare function filter<A>(predicate: Predicate<A>): (nea: NonEmptyArray<A>) => Option<NonEmptyArray<A>>
Added in v2.0.0
Derivable from Monad
.
Signature
export declare const flatten: <A>(mma: NonEmptyArray<NonEmptyArray<A>>) => NonEmptyArray<A>
Added in v2.0.0
Group equal, consecutive elements of an array into non empty arrays.
Signature
export declare function group<B>(
E: Eq<B>
): {
<A extends B>(as: NonEmptyArray<A>): NonEmptyArray<NonEmptyArray<A>>
<A extends B>(as: Array<A>): Array<NonEmptyArray<A>>
}
Example
import { cons, group } from 'fp-ts/NonEmptyArray'
import { ordNumber } from 'fp-ts/Ord'
assert.deepStrictEqual(group(ordNumber)([1, 2, 1, 1]), [cons(1, []), cons(2, []), cons(1, [1])])
Added in v2.0.0
Sort and then group the elements of an array into non empty arrays.
Signature
export declare const groupSort: <B>(
O: Ord<B>
) => {
<A extends B>(as: NonEmptyArray<A>): NonEmptyArray<NonEmptyArray<A>>
<A extends B>(as: A[]): NonEmptyArray<A>[]
}
Example
import { cons, groupSort } from 'fp-ts/NonEmptyArray'
import { ordNumber } from 'fp-ts/Ord'
assert.deepStrictEqual(groupSort(ordNumber)([1, 2, 1, 1]), [cons(1, [1, 1]), cons(2, [])])
Added in v2.0.0
Places an element in between members of an array
Signature
export declare const intersperse: <A>(e: A) => (as: NonEmptyArray<A>) => NonEmptyArray<A>
Example
import { cons, intersperse } from 'fp-ts/NonEmptyArray'
assert.deepStrictEqual(intersperse(9)(cons(1, [2, 3, 4])), cons(1, [9, 2, 9, 3, 9, 4]))
Added in v2.9.0
Prepend an element to every member of an array
Signature
export declare const prependToAll: <A>(e: A) => (xs: NonEmptyArray<A>) => NonEmptyArray<A>
Example
import { cons, prependToAll } from 'fp-ts/NonEmptyArray'
assert.deepStrictEqual(prependToAll(9)(cons(1, [2, 3, 4])), cons(9, [1, 9, 2, 9, 3, 9, 4]))
Added in v2.9.0
Signature
export declare const reverse: <A>(nea: NonEmptyArray<A>) => NonEmptyArray<A>
Added in v2.0.0
Signature
export declare const sort: <B>(O: Ord<B>) => <A extends B>(nea: NonEmptyArray<A>) => NonEmptyArray<A>
Added in v2.0.0
Signature
export declare const zip: {
<B>(bs: NonEmptyArray<B>): <A>(as: NonEmptyArray<A>) => NonEmptyArray<[A, B]>
<A, B>(as: NonEmptyArray<A>, bs: NonEmptyArray<B>): NonEmptyArray<[A, B]>
}
Added in v2.5.1
Signature
export declare const zipWith: <A, B, C>(
fa: NonEmptyArray<A>,
fb: NonEmptyArray<B>,
f: (a: A, b: B) => C
) => NonEmptyArray<C>
Added in v2.5.1
Signature
export declare function concat<A>(fx: Array<A>, fy: NonEmptyArray<A>): NonEmptyArray<A>
export declare function concat<A>(fx: NonEmptyArray<A>, fy: Array<A>): NonEmptyArray<A>
Added in v2.2.0
Append an element to the front of an array, creating a new non empty array
Signature
export declare const cons: <A>(head: A, tail: A[]) => NonEmptyArray<A>
Example
import { cons } from 'fp-ts/NonEmptyArray'
assert.deepStrictEqual(cons(1, [2, 3, 4]), [1, 2, 3, 4])
Added in v2.0.0
Builds a NonEmptyArray
from an Array
returning none
if as
is an empty array
Signature
export declare const fromArray: <A>(as: A[]) => Option<NonEmptyArray<A>>
Added in v2.0.0
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
Signature
export declare const groupBy: <A>(f: (a: A) => string) => (as: A[]) => Record<string, NonEmptyArray<A>>
Example
import { cons, groupBy } from 'fp-ts/NonEmptyArray'
assert.deepStrictEqual(groupBy((s: string) => String(s.length))(['foo', 'bar', 'foobar']), {
'3': cons('foo', ['bar']),
'6': cons('foobar', []),
})
Added in v2.0.0
Append an element to the end of an array, creating a new non empty array
Signature
export declare const snoc: <A>(init: A[], end: A) => NonEmptyArray<A>
Example
import { snoc } from 'fp-ts/NonEmptyArray'
assert.deepStrictEqual(snoc([1, 2, 3], 4), [1, 2, 3, 4])
Added in v2.0.0
Produces a couple of the first element of the array, and a new array of the remaining elements, if any
Signature
export declare const uncons: <A>(nea: NonEmptyArray<A>) => readonly [A, A[]]
Example
import { cons, uncons } from 'fp-ts/NonEmptyArray'
assert.deepStrictEqual(uncons(cons(1, [2, 3, 4])), [1, [2, 3, 4]])
Added in v2.9.0
Produces a couple of a copy of the array without its last element, and that last element
Signature
export declare const unsnoc: <A>(nea: NonEmptyArray<A>) => readonly [A[], A]
Example
import { snoc, unsnoc } from 'fp-ts/NonEmptyArray'
assert.deepStrictEqual(unsnoc(snoc([1, 2, 3], 4)), [[1, 2, 3], 4])
Added in v2.9.0
Signature
export declare const Alt: Alt1<'NonEmptyArray'>
Added in v2.7.0
Signature
export declare const Applicative: Applicative1<'NonEmptyArray'>
Added in v2.7.0
Signature
export declare const Comonad: Comonad1<'NonEmptyArray'>
Added in v2.7.0
Signature
export declare const Foldable: Foldable1<'NonEmptyArray'>
Added in v2.7.0
Signature
export declare const FoldableWithIndex: FoldableWithIndex1<'NonEmptyArray', number>
Added in v2.7.0
Signature
export declare const Functor: Functor1<'NonEmptyArray'>
Added in v2.7.0
Signature
export declare const FunctorWithIndex: FunctorWithIndex1<'NonEmptyArray', number>
Added in v2.7.0
Signature
export declare const Monad: Monad1<'NonEmptyArray'>
Added in v2.7.0
Signature
export declare const Traversable: Traversable1<'NonEmptyArray'>
Added in v2.7.0
Signature
export declare const TraversableWithIndex: TraversableWithIndex1<'NonEmptyArray', number>
Added in v2.7.0
Signature
export declare const URI: 'NonEmptyArray'
Added in v2.0.0
Signature
export type URI = typeof URI
Added in v2.0.0
Signature
export declare const getEq: <A>(E: Eq<A>) => Eq<NonEmptyArray<A>>
Example
import { getEq, cons } from 'fp-ts/NonEmptyArray'
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)
Added in v2.0.0
Builds a Semigroup
instance for NonEmptyArray
Signature
export declare const getSemigroup: <A = never>() => Semigroup<NonEmptyArray<A>>
Added in v2.0.0
Signature
export declare const getShow: <A>(S: Show<A>) => Show<NonEmptyArray<A>>
Added in v2.0.0
Signature
export declare const nonEmptyArray: Monad1<'NonEmptyArray'> &
Comonad1<'NonEmptyArray'> &
TraversableWithIndex1<'NonEmptyArray', number> &
FunctorWithIndex1<'NonEmptyArray', number> &
FoldableWithIndex1<'NonEmptyArray', number> &
Alt1<'NonEmptyArray'>
Added in v2.0.0
Signature
export interface NonEmptyArray<A> extends Array<A> {
0: A
}
Added in v2.0.0
Signature
export declare const Do: NonEmptyArray<{}>
Added in v2.9.0
Signature
export declare const apS: <A, N extends string, B>(
name: Exclude<N, keyof A>,
fb: NonEmptyArray<B>
) => (fa: NonEmptyArray<A>) => NonEmptyArray<{ [K in N | keyof A]: K extends keyof A ? A[K] : B }>
Added in v2.8.0
Signature
export declare const bind: <N extends string, A, B>(
name: Exclude<N, keyof A>,
f: (a: A) => NonEmptyArray<B>
) => (fa: NonEmptyArray<A>) => NonEmptyArray<{ [K in N | keyof A]: K extends keyof A ? A[K] : B }>
Added in v2.8.0
Signature
export declare const bindTo: <N extends string>(name: N) => <A>(fa: NonEmptyArray<A>) => NonEmptyArray<{ [K in N]: A }>
Added in v2.8.0
Signature
export declare const extract: <A>(wa: NonEmptyArray<A>) => A
Added in v2.7.0
Signature
export declare const filterWithIndex: <A>(
predicate: (i: number, a: A) => boolean
) => (nea: NonEmptyArray<A>) => Option<NonEmptyArray<A>>
Added in v2.0.0
Signature
export declare const fold: <A>(S: Semigroup<A>) => (fa: NonEmptyArray<A>) => A
Added in v2.5.0
Signature
export declare const head: <A>(nea: NonEmptyArray<A>) => A
Added in v2.0.0
Get all but the last element of a non empty array, creating a new array.
Signature
export declare const init: <A>(nea: NonEmptyArray<A>) => A[]
Example
import { init } from 'fp-ts/NonEmptyArray'
assert.deepStrictEqual(init([1, 2, 3]), [1, 2])
assert.deepStrictEqual(init([1]), [])
Added in v2.2.0
Signature
export declare const insertAt: <A>(i: number, a: A) => (nea: NonEmptyArray<A>) => Option<NonEmptyArray<A>>
Added in v2.0.0
Signature
export declare const last: <A>(nea: NonEmptyArray<A>) => A
Added in v2.0.0
Signature
export declare const max: <A>(ord: Ord<A>) => (nea: NonEmptyArray<A>) => A
Added in v2.0.0
Signature
export declare const min: <A>(ord: Ord<A>) => (nea: NonEmptyArray<A>) => A
Added in v2.0.0
Signature
export declare const modifyAt: <A>(i: number, f: (a: A) => A) => (nea: NonEmptyArray<A>) => Option<NonEmptyArray<A>>
Added in v2.0.0
Signature
export declare const sequence: Sequence1<'NonEmptyArray'>
Added in v2.6.3
Signature
export declare const tail: <A>(nea: NonEmptyArray<A>) => A[]
Added in v2.0.0
Signature
export declare const traverse: PipeableTraverse1<'NonEmptyArray'>
Added in v2.6.3
Signature
export declare const traverseWithIndex: PipeableTraverseWithIndex1<'NonEmptyArray', number>
Added in v2.6.3
Signature
export declare const unzip: <A, B>(as: NonEmptyArray<[A, B]>) => [NonEmptyArray<A>, NonEmptyArray<B>]
Added in v2.5.1
Signature
export declare const updateAt: <A>(i: number, a: A) => (nea: NonEmptyArray<A>) => Option<NonEmptyArray<A>>
Added in v2.0.0