/**
* @since 2.5.0
*/
import { Alt1 } from './Alt'
import { Alternative1 } from './Alternative'
import { Applicative1 } from './Applicative'
import { Apply1 } from './Apply'
import { Chain1 } from './Chain'
import { ChainRec1 } from './ChainRec'
import { Compactable1 } from './Compactable'
import { Either } from './Either'
import { Eq } from './Eq'
import { Extend1 } from './Extend'
import { Filterable1 } from './Filterable'
import { FilterableWithIndex1, PredicateWithIndex, RefinementWithIndex } from './FilterableWithIndex'
import { Foldable1 } from './Foldable'
import { FoldableWithIndex1 } from './FoldableWithIndex'
import { FromEither1 } from './FromEither'
import { Lazy } from './function'
import { Functor1 } from './Functor'
import { FunctorWithIndex1 } from './FunctorWithIndex'
import { Magma } from './Magma'
import { Monad1 } from './Monad'
import { Monoid } from './Monoid'
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 { Semigroup } from './Semigroup'
import { Separated } from './Separated'
import { Show } from './Show'
import { PipeableTraverse1, Traversable1 } from './Traversable'
import { PipeableTraverseWithIndex1, TraversableWithIndex1 } from './TraversableWithIndex'
import { Unfoldable1 } from './Unfoldable'
import { PipeableWilt1, PipeableWither1, Witherable1 } from './Witherable'
import { Zero1 } from './Zero'
import ReadonlyNonEmptyArray = RNEA.ReadonlyNonEmptyArray
/**
* Test whether a `ReadonlyArray` is empty.
*
* @example
* import { isEmpty } from 'fp-ts/ReadonlyArray'
*
* assert.strictEqual(isEmpty([]), true)
*
* @category refinements
* @since 2.5.0
*/
export declare const isEmpty: (as: readonly A[]) => as is readonly []
/**
* Test whether a `ReadonlyArray` is non empty.
*
* @category refinements
* @since 2.5.0
*/
export declare const isNonEmpty: (as: ReadonlyArray) => as is ReadonlyNonEmptyArray
/**
* Prepend an element to the front of a `ReadonlyArray`, creating a new `ReadonlyNonEmptyArray`.
*
* @example
* import { prepend } from 'fp-ts/ReadonlyArray'
* import { pipe } from 'fp-ts/function'
*
* assert.deepStrictEqual(pipe([2, 3, 4], prepend(1)), [1, 2, 3, 4])
*
* @since 2.10.0
*/
export declare const prepend: (head: A) => (tail: readonly A[]) => RNEA.ReadonlyNonEmptyArray
/**
* Less strict version of [`prepend`](#prepend).
*
* @since 2.11.0
*/
export declare const prependW: (head: B) => (tail: readonly A[]) => RNEA.ReadonlyNonEmptyArray
/**
* Append an element to the end of a `ReadonlyArray`, creating a new `ReadonlyNonEmptyArray`.
*
* @example
* import { append } from 'fp-ts/ReadonlyArray'
* import { pipe } from 'fp-ts/function'
*
* assert.deepStrictEqual(pipe([1, 2, 3], append(4)), [1, 2, 3, 4])
*
* @since 2.10.0
*/
export declare const append: (end: A) => (init: readonly A[]) => RNEA.ReadonlyNonEmptyArray
/**
* Less strict version of [`append`](#append).
*
* @since 2.11.0
*/
export declare const appendW: (end: B) => (init: readonly A[]) => RNEA.ReadonlyNonEmptyArray
/**
* Return a `ReadonlyArray` of length `n` with element `i` initialized with `f(i)`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* @example
* import { makeBy } from 'fp-ts/ReadonlyArray'
*
* const double = (n: number): number => n * 2
* assert.deepStrictEqual(makeBy(5, double), [0, 2, 4, 6, 8])
*
* @category constructors
* @since 2.5.0
*/
export declare const makeBy: (n: number, f: (i: number) => A) => readonly A[]
/**
* Create a `ReadonlyArray` containing a value repeated the specified number of times.
*
* **Note**. `n` is normalized to a non negative integer.
*
* @example
* import { replicate } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(replicate(3, 'a'), ['a', 'a', 'a'])
*
* @category constructors
* @since 2.5.0
*/
export declare const replicate: (n: number, a: A) => readonly A[]
/**
* @category lifting
* @since 2.11.0
*/
export declare function fromPredicate(refinement: Refinement): (a: A) => ReadonlyArray
export declare function fromPredicate(predicate: Predicate): (b: B) => ReadonlyArray
export declare function fromPredicate(predicate: Predicate): (a: A) => ReadonlyArray
/**
* @category conversions
* @since 2.11.0
*/
export declare const fromOption: (fa: Option) => ReadonlyArray
/**
* Transforms an `Either` to a `ReadonlyArray`.
*
* @category conversions
* @since 2.11.0
*/
export declare const fromEither: (fa: Either) => ReadonlyArray
/**
* Less strict version of [`match`](#match).
*
* The `W` suffix (short for **W**idening) means that the handler return types will be merged.
*
* @category pattern matching
* @since 2.11.0
*/
export declare const matchW: (
onEmpty: Lazy,
onNonEmpty: (as: RNEA.ReadonlyNonEmptyArray) => C
) => (as: readonly A[]) => B | C
/**
* @category pattern matching
* @since 2.11.0
*/
export declare const match: (
onEmpty: Lazy,
onNonEmpty: (as: ReadonlyNonEmptyArray) => B
) => (as: ReadonlyArray) => B
/**
* Less strict version of [`matchLeft`](#matchleft).
*
* @category pattern matching
* @since 2.11.0
*/
export declare const matchLeftW: (
onEmpty: Lazy,
onNonEmpty: (head: A, tail: readonly A[]) => C
) => (as: readonly A[]) => B | C
/**
* Break a `ReadonlyArray` into its first element and remaining elements.
*
* @example
* import { matchLeft } from 'fp-ts/ReadonlyArray'
*
* const len: (as: ReadonlyArray) => number = matchLeft(() => 0, (_, tail) => 1 + len(tail))
* assert.strictEqual(len([1, 2, 3]), 3)
*
* @category pattern matching
* @since 2.10.0
*/
export declare const matchLeft: (
onEmpty: Lazy,
onNonEmpty: (head: A, tail: ReadonlyArray) => B
) => (as: ReadonlyArray) => B
/**
* Alias of [`matchLeft`](#matchleft).
*
* @category pattern matching
* @since 2.5.0
*/
export declare const foldLeft: (
onEmpty: Lazy,
onNonEmpty: (head: A, tail: ReadonlyArray) => B
) => (as: ReadonlyArray) => B
/**
* Less strict version of [`matchRight`](#matchright).
*
* @category pattern matching
* @since 2.11.0
*/
export declare const matchRightW: (
onEmpty: Lazy,
onNonEmpty: (init: readonly A[], last: A) => C
) => (as: readonly A[]) => B | C
/**
* Break a `ReadonlyArray` into its initial elements and the last element.
*
* @category pattern matching
* @since 2.10.0
*/
export declare const matchRight: (
onEmpty: Lazy,
onNonEmpty: (init: ReadonlyArray, last: A) => B
) => (as: ReadonlyArray) => B
/**
* Alias of [`matchRight`](#matchright).
*
* @category pattern matching
* @since 2.5.0
*/
export declare const foldRight: (
onEmpty: Lazy,
onNonEmpty: (init: ReadonlyArray, last: A) => B
) => (as: ReadonlyArray) => B
/**
* @category sequencing
* @since 2.7.0
*/
export declare const chainWithIndex: (f: (i: number, a: A) => readonly B[]) => (as: readonly A[]) => readonly B[]
/**
* Same as `reduce` but it carries over the intermediate steps.
*
* @example
* import { scanLeft } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(scanLeft(10, (b, a: number) => b - a)([1, 2, 3]), [10, 9, 7, 4])
*
* @since 2.5.0
*/
export declare const scanLeft: (b: B, f: (b: B, a: A) => B) => (as: readonly A[]) => RNEA.ReadonlyNonEmptyArray
/**
* Fold an array from the right, keeping all intermediate results instead of only the final result
*
* @example
* import { scanRight } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(scanRight(10, (a: number, b) => b - a)([1, 2, 3]), [4, 5, 7, 10])
*
* @since 2.5.0
*/
export declare const scanRight: (
b: B,
f: (a: A, b: B) => B
) => (as: readonly A[]) => RNEA.ReadonlyNonEmptyArray
/**
* Calculate the number of elements in a `ReadonlyArray`.
*
* @since 2.10.0
*/
export declare const size: (as: readonly A[]) => number
/**
* Test whether an array contains a particular index
*
* @since 2.5.0
*/
export declare const isOutOfBound: (i: number, as: ReadonlyArray) => boolean
/**
* This function provides a safe way to read a value at a particular index from an array
*
* @example
* import { lookup } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
* import { pipe } from 'fp-ts/function'
*
* assert.deepStrictEqual(pipe([1, 2, 3], lookup(1)), some(2))
* assert.deepStrictEqual(pipe([1, 2, 3], lookup(3)), none)
*
* @since 2.5.0
*/
export declare function lookup(i: number): (as: ReadonlyArray) => Option
export declare function lookup(i: number, as: ReadonlyArray): Option
/**
* Get the first element in an array, or `None` if the array is empty
*
* @example
* import { head } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* assert.deepStrictEqual(head([1, 2, 3]), some(1))
* assert.deepStrictEqual(head([]), none)
*
* @since 2.5.0
*/
export declare const head: (as: readonly A[]) => Option
/**
* Get the last element in an array, or `None` if the array is empty
*
* @example
* import { last } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* assert.deepStrictEqual(last([1, 2, 3]), some(3))
* assert.deepStrictEqual(last([]), none)
*
* @since 2.5.0
*/
export declare const last: (as: readonly A[]) => Option
/**
* Get all but the first element of an array, creating a new array, or `None` if the array is empty
*
* @example
* import { tail } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* assert.deepStrictEqual(tail([1, 2, 3]), some([2, 3]))
* assert.deepStrictEqual(tail([]), none)
*
* @since 2.5.0
*/
export declare const tail: (as: readonly A[]) => Option
/**
* Get all but the last element of an array, creating a new array, or `None` if the array is empty
*
* @example
* import { init } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* assert.deepStrictEqual(init([1, 2, 3]), some([1, 2]))
* assert.deepStrictEqual(init([]), none)
*
* @since 2.5.0
*/
export declare const init: (as: readonly A[]) => Option
/**
* Keep only a max number of elements from the start of an `ReadonlyArray`, creating a new `ReadonlyArray`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
* import { pipe } from 'fp-ts/function'
*
* const input: ReadonlyArray = [1, 2, 3]
* assert.deepStrictEqual(pipe(input, RA.takeLeft(2)), [1, 2])
*
* // out of bounds
* assert.strictEqual(pipe(input, RA.takeLeft(4)), input)
* assert.strictEqual(pipe(input, RA.takeLeft(-1)), input)
*
* @since 2.5.0
*/
export declare const takeLeft: (n: number) => (as: readonly A[]) => readonly A[]
/**
* Keep only a max number of elements from the end of an `ReadonlyArray`, creating a new `ReadonlyArray`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
* import { pipe } from 'fp-ts/function'
*
* const input: ReadonlyArray = [1, 2, 3]
* assert.deepStrictEqual(pipe(input, RA.takeRight(2)), [2, 3])
*
* // out of bounds
* assert.strictEqual(pipe(input, RA.takeRight(4)), input)
* assert.strictEqual(pipe(input, RA.takeRight(-1)), input)
*
* @since 2.5.0
*/
export declare const takeRight: (n: number) => (as: readonly A[]) => readonly A[]
/**
* Calculate the longest initial subarray for which all element satisfy the specified predicate, creating a new array
*
* @example
* import { takeLeftWhile } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(takeLeftWhile((n: number) => n % 2 === 0)([2, 4, 3, 6]), [2, 4])
*
* @since 2.5.0
*/
export declare function takeLeftWhile(
refinement: Refinement
): (as: ReadonlyArray) => ReadonlyArray
export declare function takeLeftWhile(
predicate: Predicate
): (bs: ReadonlyArray) => ReadonlyArray
export declare function takeLeftWhile(predicate: Predicate): (as: ReadonlyArray) => ReadonlyArray
/**
* @since 2.5.0
*/
export interface Spanned {
readonly init: ReadonlyArray
readonly rest: ReadonlyArray
}
/**
* Split an array into two parts:
* 1. the longest initial subarray for which all elements satisfy the specified predicate
* 2. the remaining elements
*
* @example
* import { spanLeft } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(spanLeft((n: number) => n % 2 === 1)([1, 3, 2, 4, 5]), { init: [1, 3], rest: [2, 4, 5] })
*
* @since 2.5.0
*/
export declare function spanLeft(refinement: Refinement): (as: ReadonlyArray) => Spanned
export declare function spanLeft(predicate: Predicate): (bs: ReadonlyArray) => Spanned
export declare function spanLeft(predicate: Predicate): (as: ReadonlyArray) => Spanned
/**
* Drop a max number of elements from the start of an `ReadonlyArray`, creating a new `ReadonlyArray`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
* import { pipe } from 'fp-ts/function'
*
* const input: ReadonlyArray = [1, 2, 3]
* assert.deepStrictEqual(pipe(input, RA.dropLeft(2)), [3])
* assert.strictEqual(pipe(input, RA.dropLeft(0)), input)
* assert.strictEqual(pipe(input, RA.dropLeft(-1)), input)
*
* @since 2.5.0
*/
export declare const dropLeft: (n: number) => (as: readonly A[]) => readonly A[]
/**
* Drop a max number of elements from the end of an `ReadonlyArray`, creating a new `ReadonlyArray`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
* import { pipe } from 'fp-ts/function'
*
* const input: ReadonlyArray = [1, 2, 3]
* assert.deepStrictEqual(pipe(input, RA.dropRight(2)), [1])
* assert.strictEqual(pipe(input, RA.dropRight(0)), input)
* assert.strictEqual(pipe(input, RA.dropRight(-1)), input)
*
* @since 2.5.0
*/
export declare const dropRight: (n: number) => (as: readonly A[]) => readonly A[]
/**
* Remove the longest initial subarray for which all element satisfy the specified predicate, creating a new array
*
* @example
* import { dropLeftWhile } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(dropLeftWhile((n: number) => n % 2 === 1)([1, 3, 2, 4, 5]), [2, 4, 5])
*
* @since 2.5.0
*/
export declare function dropLeftWhile(
refinement: Refinement
): (as: ReadonlyArray) => ReadonlyArray
export declare function dropLeftWhile(
predicate: Predicate
): (bs: ReadonlyArray) => ReadonlyArray
export declare function dropLeftWhile(predicate: Predicate): (as: ReadonlyArray) => ReadonlyArray
/**
* Find the first index for which a predicate holds
*
* @example
* import { findIndex } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* assert.deepStrictEqual(findIndex((n: number) => n === 2)([1, 2, 3]), some(1))
* assert.deepStrictEqual(findIndex((n: number) => n === 2)([]), none)
*
* @since 2.5.0
*/
export declare const findIndex: (predicate: Predicate) => (as: readonly A[]) => Option
/**
* Find the first element which satisfies a predicate (or a refinement) function
*
* @example
* import { findFirst } from 'fp-ts/ReadonlyArray'
* import { some } from 'fp-ts/Option'
*
* type X = {
* readonly a: number
* readonly b: number
* }
*
* assert.deepStrictEqual(findFirst((x: X) => x.a === 1)([{ a: 1, b: 1 }, { a: 1, b: 2 }]), some({ a: 1, b: 1 }))
*
* @since 2.5.0
*/
export declare function findFirst(refinement: Refinement): (as: ReadonlyArray) => Option
export declare function findFirst(predicate: Predicate): (bs: ReadonlyArray) => Option
export declare function findFirst(predicate: Predicate): (as: ReadonlyArray) => Option
/**
* Find the first element returned by an option based selector function
*
* @example
* import { findFirstMap } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* interface Person {
* readonly name: string
* readonly age?: number
* }
*
* const persons: ReadonlyArray = [{ name: 'John' }, { name: 'Mary', age: 45 }, { name: 'Joey', age: 28 }]
*
* // returns the name of the first person that has an age
* assert.deepStrictEqual(findFirstMap((p: Person) => (p.age === undefined ? none : some(p.name)))(persons), some('Mary'))
*
* @since 2.5.0
*/
export declare const findFirstMap: (f: (a: A) => Option) => (as: readonly A[]) => Option
/**
* Find the last element which satisfies a predicate function
*
* @example
* import { findLast } from 'fp-ts/ReadonlyArray'
* import { some } from 'fp-ts/Option'
*
* type X = {
* readonly a: number
* readonly b: number
* }
*
* assert.deepStrictEqual(findLast((x: X) => x.a === 1)([{ a: 1, b: 1 }, { a: 1, b: 2 }]), some({ a: 1, b: 2 }))
*
* @since 2.5.0
*/
export declare function findLast(refinement: Refinement): (as: ReadonlyArray) => Option
export declare function findLast(predicate: Predicate): (bs: ReadonlyArray) => Option
export declare function findLast(predicate: Predicate): (as: ReadonlyArray) => Option
/**
* Find the last element returned by an option based selector function
*
* @example
* import { findLastMap } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* interface Person {
* readonly name: string
* readonly age?: number
* }
*
* const persons: ReadonlyArray = [{ name: 'John' }, { name: 'Mary', age: 45 }, { name: 'Joey', age: 28 }]
*
* // returns the name of the last person that has an age
* assert.deepStrictEqual(findLastMap((p: Person) => (p.age === undefined ? none : some(p.name)))(persons), some('Joey'))
*
* @since 2.5.0
*/
export declare const findLastMap: (f: (a: A) => Option) => (as: readonly A[]) => Option
/**
* Returns the index of the last element of the list which matches the predicate
*
* @example
* import { findLastIndex } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* interface X {
* readonly a: number
* readonly b: number
* }
* const xs: ReadonlyArray = [{ a: 1, b: 0 }, { a: 1, b: 1 }]
* assert.deepStrictEqual(findLastIndex((x: { readonly a: number }) => x.a === 1)(xs), some(1))
* assert.deepStrictEqual(findLastIndex((x: { readonly a: number }) => x.a === 4)(xs), none)
*
*
* @since 2.5.0
*/
export declare const findLastIndex: (predicate: Predicate) => (as: readonly A[]) => Option
/**
* Insert an element at the specified index, creating a new array, or returning `None` if the index is out of bounds
*
* @example
* import { insertAt } from 'fp-ts/ReadonlyArray'
* import { some } from 'fp-ts/Option'
*
* assert.deepStrictEqual(insertAt(2, 5)([1, 2, 3, 4]), some([1, 2, 5, 3, 4]))
*
* @since 2.5.0
*/
export declare const insertAt: (i: number, a: A) => (as: readonly A[]) => Option>
/**
* Change the element at the specified index, creating a new array, or returning `None` if the index is out of bounds
*
* @example
* import { updateAt } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* assert.deepStrictEqual(updateAt(1, 1)([1, 2, 3]), some([1, 1, 3]))
* assert.deepStrictEqual(updateAt(1, 1)([]), none)
*
* @since 2.5.0
*/
export declare const updateAt: (i: number, a: A) => (as: readonly A[]) => Option
/**
* Delete the element at the specified index, creating a new array, or returning `None` if the index is out of bounds
*
* @example
* import { deleteAt } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* assert.deepStrictEqual(deleteAt(0)([1, 2, 3]), some([2, 3]))
* assert.deepStrictEqual(deleteAt(1)([]), none)
*
* @since 2.5.0
*/
export declare const deleteAt: (i: number) => (as: readonly A[]) => Option
/**
* Apply a function to the element at the specified index, creating a new array, or returning `None` if the index is out
* of bounds
*
* @example
* import { modifyAt } from 'fp-ts/ReadonlyArray'
* import { some, none } from 'fp-ts/Option'
*
* const double = (x: number): number => x * 2
* assert.deepStrictEqual(modifyAt(1, double)([1, 2, 3]), some([1, 4, 3]))
* assert.deepStrictEqual(modifyAt(1, double)([]), none)
*
* @since 2.5.0
*/
export declare const modifyAt: (i: number, f: (a: A) => A) => (as: readonly A[]) => Option
/**
* Reverse an array, creating a new array
*
* @example
* import { reverse } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(reverse([1, 2, 3]), [3, 2, 1])
*
* @since 2.5.0
*/
export declare const reverse: (as: readonly A[]) => readonly A[]
/**
* Extracts from an array of `Either` all the `Right` elements. All the `Right` elements are extracted in order
*
* @example
* import { rights } from 'fp-ts/ReadonlyArray'
* import { right, left } from 'fp-ts/Either'
*
* assert.deepStrictEqual(rights([right(1), left('foo'), right(2)]), [1, 2])
*
* @since 2.5.0
*/
export declare const rights: (as: readonly Either[]) => readonly A[]
/**
* Extracts from an array of `Either` all the `Left` elements. All the `Left` elements are extracted in order
*
* @example
* import { lefts } from 'fp-ts/ReadonlyArray'
* import { left, right } from 'fp-ts/Either'
*
* assert.deepStrictEqual(lefts([right(1), left('foo'), right(2)]), ['foo'])
*
* @since 2.5.0
*/
export declare const lefts: (as: readonly Either[]) => readonly E[]
/**
* Sort the elements of an array in increasing order, creating a new array
*
* @example
* import { sort } from 'fp-ts/ReadonlyArray'
* import * as N from 'fp-ts/number'
*
* assert.deepStrictEqual(sort(N.Ord)([3, 2, 1]), [1, 2, 3])
*
* @since 2.5.0
*/
export declare const sort: (O: Ord) => (as: readonly A[]) => readonly A[]
/**
* Apply a function to pairs of elements at the same index in two arrays, collecting the results in a new array. If one
* input array is short, excess elements of the longer array are discarded.
*
* @example
* import { zipWith } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(zipWith([1, 2, 3], ['a', 'b', 'c', 'd'], (n, s) => s + n), ['a1', 'b2', 'c3'])
*
* @since 2.5.0
*/
export declare const zipWith: (fa: readonly A[], fb: readonly B[], f: (a: A, b: B) => C) => readonly C[]
/**
* Takes two arrays and returns an array of corresponding pairs. If one input array is short, excess elements of the
* longer array are discarded
*
* @example
* import { zip } from 'fp-ts/ReadonlyArray'
* import { pipe } from 'fp-ts/function'
*
* assert.deepStrictEqual(pipe([1, 2, 3], zip(['a', 'b', 'c', 'd'])), [[1, 'a'], [2, 'b'], [3, 'c']])
*
* @since 2.5.0
*/
export declare function zip(bs: ReadonlyArray): (as: ReadonlyArray) => ReadonlyArray
export declare function zip(as: ReadonlyArray, bs: ReadonlyArray): ReadonlyArray
/**
* The function is reverse of `zip`. Takes an array of pairs and return two corresponding arrays
*
* @example
* import { unzip } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(unzip([[1, 'a'], [2, 'b'], [3, 'c']]), [[1, 2, 3], ['a', 'b', 'c']])
*
* @since 2.5.0
*/
export declare const unzip: (as: readonly (readonly [A, B])[]) => readonly [readonly A[], readonly B[]]
/**
* Prepend an element to every member of an array
*
* @example
* import { prependAll } from 'fp-ts/ReadonlyArray'
*
* 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: readonly A[]) => readonly A[]
/**
* Places an element in between members of an array
*
* @example
* import { intersperse } from 'fp-ts/ReadonlyArray'
*
* 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: readonly A[]) => readonly A[]
/**
* Rotate a `ReadonlyArray` by `n` steps.
*
* @example
* import { rotate } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(rotate(2)([1, 2, 3, 4, 5]), [4, 5, 1, 2, 3])
*
* @since 2.5.0
*/
export declare const rotate: (n: number) => (as: readonly A[]) => readonly A[]
/**
* Test if a value is a member of an array. Takes a `Eq` as a single
* argument which returns the function to use to search for a value of type `A` in
* an array of type `ReadonlyArray`.
*
* @example
* import { elem } from 'fp-ts/ReadonlyArray'
* import * as N from 'fp-ts/number'
* import { pipe } from 'fp-ts/function'
*
* assert.strictEqual(pipe([1, 2, 3], elem(N.Eq)(2)), true)
* assert.strictEqual(pipe([1, 2, 3], elem(N.Eq)(0)), false)
*
* @since 2.5.0
*/
export declare function elem(E: Eq): {
(a: A): (as: ReadonlyArray) => boolean
(a: A, as: ReadonlyArray): boolean
}
/**
* Remove duplicates from an array, keeping the first occurrence of an element.
*
* @example
* import { uniq } from 'fp-ts/ReadonlyArray'
* import * as N from 'fp-ts/number'
*
* assert.deepStrictEqual(uniq(N.Eq)([1, 2, 1]), [1, 2])
*
* @since 2.5.0
*/
export declare const uniq: (E: Eq) => (as: readonly A[]) => readonly A[]
/**
* Sort the elements of an array in increasing order, where elements are compared using first `ords[0]`, then `ords[1]`,
* etc...
*
* @example
* import { sortBy } from 'fp-ts/ReadonlyArray'
* 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 {
* readonly name: string
* readonly age: number
* }
* const byName = pipe(S.Ord, contramap((p: Person) => p.name))
* const byAge = pipe(N.Ord, contramap((p: Person) => p.age))
*
* const sortByNameByAge = sortBy([byName, byAge])
*
* const persons = [{ 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.5.0
*/
export declare const sortBy: (ords: readonly Ord[]) => (as: readonly A[]) => readonly A[]
/**
* A useful recursion pattern for processing a `ReadonlyArray` to produce a new `ReadonlyArray`, often used for "chopping" up the input
* `ReadonlyArray`. Typically `chop` is called with some function that will consume an initial prefix of the `ReadonlyArray` and produce a
* value and the tail of the `ReadonlyArray`.
*
* @example
* import { Eq } from 'fp-ts/Eq'
* import * as RA from 'fp-ts/ReadonlyArray'
* import * as N from 'fp-ts/number'
* import { pipe } from 'fp-ts/function'
*
* const group = (S: Eq): ((as: ReadonlyArray) => ReadonlyArray>) => {
* return RA.chop(as => {
* const { init, rest } = pipe(as, RA.spanLeft((a: A) => S.equals(a, as[0])))
* return [init, rest]
* })
* }
* assert.deepStrictEqual(group(N.Eq)([1, 1, 2, 3, 3, 4]), [[1, 1], [2], [3, 3], [4]])
*
* @since 2.5.0
*/
export declare const chop: (
f: (as: RNEA.ReadonlyNonEmptyArray) => readonly [B, readonly A[]]
) => (as: readonly A[]) => readonly B[]
/**
* Splits a `ReadonlyArray` into two pieces, the first piece has max `n` elements.
*
* @example
* import { splitAt } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(splitAt(2)([1, 2, 3, 4, 5]), [[1, 2], [3, 4, 5]])
*
* @since 2.5.0
*/
export declare const splitAt: (n: number) => (as: readonly A[]) => readonly [readonly A[], readonly A[]]
/**
* Splits a `ReadonlyArray` into length-`n` pieces. The last piece will be shorter if `n` does not evenly divide the length of
* the `ReadonlyArray`. Note that `chunksOf(n)([])` is `[]`, not `[[]]`. This is intentional, and is consistent with a recursive
* definition of `chunksOf`; it satisfies the property that:
*
* ```ts
* chunksOf(n)(xs).concat(chunksOf(n)(ys)) == chunksOf(n)(xs.concat(ys)))
* ```
*
* whenever `n` evenly divides the length of `as`.
*
* @example
* import { chunksOf } from 'fp-ts/ReadonlyArray'
*
* assert.deepStrictEqual(chunksOf(2)([1, 2, 3, 4, 5]), [[1, 2], [3, 4], [5]])
*
* @since 2.5.0
*/
export declare const chunksOf: (n: number) => (as: readonly A[]) => readonly RNEA.ReadonlyNonEmptyArray[]
/**
* @category lifting
* @since 2.11.0
*/
export declare const fromOptionK: (
f: (...a: A) => Option
) => (...a: A) => readonly B[]
/**
* `ReadonlyArray` comprehension.
*
* ```
* [ f(x, y, ...) | x ← xs, y ← ys, ..., g(x, y, ...) ]
* ```
*
* @example
* import { comprehension } from 'fp-ts/ReadonlyArray'
* import { tuple } from 'fp-ts/function'
*
* assert.deepStrictEqual(comprehension([[1, 2, 3], ['a', 'b']], tuple, (a, b) => (a + b.length) % 2 === 0), [
* [1, 'a'],
* [1, 'b'],
* [3, 'a'],
* [3, 'b']
* ])
*
* @since 2.5.0
*/
export declare function comprehension(
input: readonly [ReadonlyArray, ReadonlyArray, ReadonlyArray, ReadonlyArray],
f: (a: A, b: B, c: C, d: D) => R,
g?: (a: A, b: B, c: C, d: D) => boolean
): ReadonlyArray
export declare function comprehension(
input: readonly [ReadonlyArray, ReadonlyArray, ReadonlyArray],
f: (a: A, b: B, c: C) => R,
g?: (a: A, b: B, c: C) => boolean
): ReadonlyArray
export declare function comprehension(
input: readonly [ReadonlyArray, ReadonlyArray],
f: (a: A, b: B) => R,
g?: (a: A, b: B) => boolean
): ReadonlyArray
export declare function comprehension(
input: readonly [ReadonlyArray],
f: (a: A) => R,
g?: (a: A) => boolean
): ReadonlyArray
/**
* @since 2.11.0
*/
export declare const concatW: (second: readonly B[]) => (first: readonly A[]) => readonly (B | A)[]
/**
* @since 2.11.0
*/
export declare const concat: (second: ReadonlyArray) => (first: ReadonlyArray) => ReadonlyArray
/**
* Creates an array of unique values, in order, from all given arrays using a `Eq` for equality comparisons
*
* @example
* import { union } from 'fp-ts/ReadonlyArray'
* import * as N from 'fp-ts/number'
* import { pipe } from 'fp-ts/function'
*
* assert.deepStrictEqual(pipe([1, 2], union(N.Eq)([2, 3])), [1, 2, 3])
*
* @since 2.5.0
*/
export declare function union(E: Eq): {
(xs: ReadonlyArray): (ys: ReadonlyArray) => ReadonlyArray
(xs: ReadonlyArray, ys: ReadonlyArray): ReadonlyArray
}
/**
* Creates an array of unique values that are included in all given arrays using a `Eq` for equality
* comparisons. The order and references of result values are determined by the first array.
*
* @example
* import { intersection } from 'fp-ts/ReadonlyArray'
* import * as N from 'fp-ts/number'
* import { pipe } from 'fp-ts/function'
*
* assert.deepStrictEqual(pipe([1, 2], intersection(N.Eq)([2, 3])), [2])
*
* @since 2.5.0
*/
export declare function intersection(E: Eq): {
(xs: ReadonlyArray): (ys: ReadonlyArray) => ReadonlyArray
(xs: ReadonlyArray, ys: ReadonlyArray): ReadonlyArray
}
/**
* Creates an array of array values not included in the other given array using a `Eq` for equality
* comparisons. The order and references of result values are determined by the first array.
*
* @example
* import { difference } from 'fp-ts/ReadonlyArray'
* import * as N from 'fp-ts/number'
* import { pipe } from 'fp-ts/function'
*
* assert.deepStrictEqual(pipe([1, 2], difference(N.Eq)([2, 3])), [1])
*
* @since 2.5.0
*/
export declare function difference(E: Eq): {
(xs: ReadonlyArray): (ys: ReadonlyArray) => ReadonlyArray
(xs: ReadonlyArray, ys: ReadonlyArray): ReadonlyArray
}
/**
* @category constructors
* @since 2.5.0
*/
export declare const of: (a: A) => ReadonlyArray
/**
* @since 2.7.0
*/
export declare const zero: () => ReadonlyArray
/**
* Less strict version of [`alt`](#alt).
*
* The `W` suffix (short for **W**idening) means that the return types will be merged.
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
* import { pipe } from 'fp-ts/function'
*
* assert.deepStrictEqual(
* pipe(
* [1, 2, 3],
* RA.altW(() => ['a', 'b'])
* ),
* [1, 2, 3, 'a', 'b']
* )
*
* @category error handling
* @since 2.9.0
*/
export declare const altW: (that: Lazy) => (fa: readonly A[]) => readonly (B | A)[]
/**
* Identifies an associative operation on a type constructor. It is similar to `Semigroup`, except that it applies to
* types of kind `* -> *`.
*
* In case of `ReadonlyArray` concatenates the inputs into a single array.
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
* import { pipe } from 'fp-ts/function'
*
* assert.deepStrictEqual(
* pipe(
* [1, 2, 3],
* RA.alt(() => [4, 5])
* ),
* [1, 2, 3, 4, 5]
* )
*
* @category error handling
* @since 2.5.0
*/
export declare const alt: (that: Lazy>) => (fa: ReadonlyArray) => ReadonlyArray
/**
* @since 2.5.0
*/
export declare const ap: (fa: ReadonlyArray) => (fab: ReadonlyArray<(a: A) => B>) => ReadonlyArray
/**
* Composes computations in sequence, using the return value of one computation to determine the next computation.
*
* @example
* import * as RA from 'fp-ts/ReadonlyArray'
* import { pipe } from 'fp-ts/function'
*
* assert.deepStrictEqual(
* pipe(
* [1, 2, 3],
* RA.chain((n) => [`a${n}`, `b${n}`])
* ),
* ['a1', 'b1', 'a2', 'b2', 'a3', 'b3']
* )
* assert.deepStrictEqual(
* pipe(
* [1, 2, 3],
* RA.chain(() => [])
* ),
* []
* )
*
* @category sequencing
* @since 2.5.0
*/
export declare const chain: (f: (a: A) => ReadonlyArray) => (ma: ReadonlyArray) => ReadonlyArray
/**
* @category sequencing
* @since 2.5.0
*/
export declare const flatten: (mma: ReadonlyArray>) => ReadonlyArray
/**
* `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.5.0
*/
export declare const map: (f: (a: A) => B) => (fa: ReadonlyArray) => ReadonlyArray
/**
* @category mapping
* @since 2.5.0
*/
export declare const mapWithIndex: (f: (i: number, a: A) => B) => (fa: ReadonlyArray) => ReadonlyArray
/**
* @category filtering
* @since 2.5.0
*/
export declare const separate: (fa: readonly Either[]) => Separated
/**
* @category filtering
* @since 2.5.0
*/
export declare const filter: {
(refinement: Refinement): (as: ReadonlyArray) => ReadonlyArray
(predicate: Predicate): (bs: ReadonlyArray) => ReadonlyArray
(predicate: Predicate): (as: ReadonlyArray) => ReadonlyArray
}
/**
* @category filtering
* @since 2.5.0
*/
export declare const filterMapWithIndex: (f: (i: number, a: A) => Option) => (fa: readonly A[]) => readonly B[]
/**
* @category filtering
* @since 2.5.0
*/
export declare const filterMap: (f: (a: A) => Option) => (fa: ReadonlyArray) => ReadonlyArray
/**
* @category filtering
* @since 2.5.0
*/
export declare const compact: (fa: ReadonlyArray>) => ReadonlyArray
/**
* @category filtering
* @since 2.5.0
*/
export declare const partition: {
(refinement: Refinement): (
as: ReadonlyArray
) => Separated, ReadonlyArray>
(predicate: Predicate): (bs: ReadonlyArray) => Separated, ReadonlyArray>
(predicate: Predicate): (as: ReadonlyArray) => Separated, ReadonlyArray>
}
/**
* @category filtering
* @since 2.5.0
*/
export declare const partitionWithIndex: {
(refinementWithIndex: RefinementWithIndex): (
as: ReadonlyArray
) => Separated, ReadonlyArray>
(predicateWithIndex: PredicateWithIndex): (
bs: ReadonlyArray
) => Separated, ReadonlyArray>
(predicateWithIndex: PredicateWithIndex): (
as: ReadonlyArray
) => Separated, ReadonlyArray>
}
/**
* @category filtering
* @since 2.5.0
*/
export declare const partitionMap: (
f: (a: A) => Either
) => (fa: ReadonlyArray) => Separated, ReadonlyArray>
/**
* @category filtering
* @since 2.5.0
*/
export declare const partitionMapWithIndex: (
f: (i: number, a: A) => Either
) => (fa: readonly A[]) => Separated
/**
* @category filtering
* @since 2.5.0
*/
export declare const filterWithIndex: {
(refinementWithIndex: RefinementWithIndex