Lorem Ipsum MCP Server
by ssv445
Array.ts•191 kB
/**
* This module provides utility functions for working with arrays in TypeScript.
*
* @since 2.0.0
*/
import * as Either from "./Either.js"
import * as Equal from "./Equal.js"
import * as Equivalence from "./Equivalence.js"
import type { LazyArg } from "./Function.js"
import { dual, identity } from "./Function.js"
import type { TypeLambda } from "./HKT.js"
import * as internalArray from "./internal/array.js"
import * as internalDoNotation from "./internal/doNotation.js"
import * as moduleIterable from "./Iterable.js"
import * as Option from "./Option.js"
import * as Order from "./Order.js"
import * as Predicate from "./Predicate.js"
import * as Record from "./Record.js"
import * as Tuple from "./Tuple.js"
import type { NoInfer } from "./Types.js"
/**
* @category type lambdas
* @since 2.0.0
*/
export interface ReadonlyArrayTypeLambda extends TypeLambda {
readonly type: ReadonlyArray<this["Target"]>
}
/**
* @category models
* @since 2.0.0
*/
export type NonEmptyReadonlyArray<A> = readonly [A, ...Array<A>]
/**
* @category models
* @since 2.0.0
*/
export type NonEmptyArray<A> = [A, ...Array<A>]
/**
* Builds a `NonEmptyArray` from an non-empty collection of elements.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.make(1, 2, 3)
* console.log(result) // [1, 2, 3]
* ```
*
* @category constructors
* @since 2.0.0
*/
export const make = <Elements extends NonEmptyArray<any>>(
...elements: Elements
): NonEmptyArray<Elements[number]> => elements
/**
* Creates a new `Array` of the specified length.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.allocate<number>(3)
* console.log(result) // [ <3 empty items> ]
* ```
*
* @category constructors
* @since 2.0.0
*/
export const allocate = <A = never>(n: number): Array<A | undefined> => new Array(n)
/**
* Return a `NonEmptyArray` of length `n` with element `i` initialized with `f(i)`.
*
* **Note**. `n` is normalized to an integer >= 1.
*
* **Example**
*
* ```ts
* import { makeBy } from "effect/Array"
*
* const result = makeBy(5, n => n * 2)
* console.log(result) // [0, 2, 4, 6, 8]
* ```
*
* @category constructors
* @since 2.0.0
*/
export const makeBy: {
/**
* Return a `NonEmptyArray` of length `n` with element `i` initialized with `f(i)`.
*
* **Note**. `n` is normalized to an integer >= 1.
*
* **Example**
*
* ```ts
* import { makeBy } from "effect/Array"
*
* const result = makeBy(5, n => n * 2)
* console.log(result) // [0, 2, 4, 6, 8]
* ```
*
* @category constructors
* @since 2.0.0
*/
<A>(f: (i: number) => A): (n: number) => NonEmptyArray<A>
/**
* Return a `NonEmptyArray` of length `n` with element `i` initialized with `f(i)`.
*
* **Note**. `n` is normalized to an integer >= 1.
*
* **Example**
*
* ```ts
* import { makeBy } from "effect/Array"
*
* const result = makeBy(5, n => n * 2)
* console.log(result) // [0, 2, 4, 6, 8]
* ```
*
* @category constructors
* @since 2.0.0
*/
<A>(n: number, f: (i: number) => A): NonEmptyArray<A>
} = dual(2, <A>(n: number, f: (i: number) => A) => {
const max = Math.max(1, Math.floor(n))
const out = new Array(max)
for (let i = 0; i < max; i++) {
out[i] = f(i)
}
return out as NonEmptyArray<A>
})
/**
* Return a `NonEmptyArray` containing a range of integers, including both endpoints.
*
* **Example**
*
* ```ts
* import { range } from "effect/Array"
*
* const result = range(1, 3)
* console.log(result) // [1, 2, 3]
* ```
*
* @category constructors
* @since 2.0.0
*/
export const range = (start: number, end: number): NonEmptyArray<number> =>
start <= end ? makeBy(end - start + 1, (i) => start + i) : [start]
/**
* Return a `NonEmptyArray` containing a value repeated the specified number of times.
*
* **Note**. `n` is normalized to an integer >= 1.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.replicate("a", 3)
* console.log(result) // ["a", "a", "a"]
* ```
*
* @category constructors
* @since 2.0.0
*/
export const replicate: {
/**
* Return a `NonEmptyArray` containing a value repeated the specified number of times.
*
* **Note**. `n` is normalized to an integer >= 1.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.replicate("a", 3)
* console.log(result) // ["a", "a", "a"]
* ```
*
* @category constructors
* @since 2.0.0
*/
(n: number): <A>(a: A) => NonEmptyArray<A>
/**
* Return a `NonEmptyArray` containing a value repeated the specified number of times.
*
* **Note**. `n` is normalized to an integer >= 1.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.replicate("a", 3)
* console.log(result) // ["a", "a", "a"]
* ```
*
* @category constructors
* @since 2.0.0
*/
<A>(a: A, n: number): NonEmptyArray<A>
} = dual(2, <A>(a: A, n: number): NonEmptyArray<A> => makeBy(n, () => a))
/**
* Creates a new `Array` from an iterable collection of values.
* If the input is already an array, it returns the input as-is.
* Otherwise, it converts the iterable collection to an array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.fromIterable(new Set([1, 2, 3]))
* console.log(result) // [1, 2, 3]
* ```
*
* @category constructors
* @since 2.0.0
*/
export const fromIterable = <A>(collection: Iterable<A>): Array<A> =>
Array.isArray(collection) ? collection : Array.from(collection)
/**
* Creates a new `Array` from a value that might not be an iterable.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* console.log(Array.ensure("a")) // ["a"]
* console.log(Array.ensure(["a"])) // ["a"]
* console.log(Array.ensure(["a", "b", "c"])) // ["a", "b", "c"]
* ```
*
* @category constructors
* @since 3.3.0
*/
export const ensure = <A>(self: ReadonlyArray<A> | A): Array<A> => Array.isArray(self) ? self : [self as A]
/**
* Takes a record and returns an array of tuples containing its keys and values.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.fromRecord({ a: 1, b: 2, c: 3 })
* console.log(result) // [["a", 1], ["b", 2], ["c", 3]]
* ```
*
* @category conversions
* @since 2.0.0
*/
export const fromRecord: <K extends string, A>(self: Readonly<Record<K, A>>) => Array<[K, A]> = Record.toEntries
/**
* Converts an `Option` to an array.
*
* **Example**
*
* ```ts
* import { Array, Option } from "effect"
*
* console.log(Array.fromOption(Option.some(1))) // [1]
* console.log(Array.fromOption(Option.none())) // []
* ```
*
* @category conversions
* @since 2.0.0
*/
export const fromOption: <A>(self: Option.Option<A>) => Array<A> = Option.toArray
/**
* Matches the elements of an array, applying functions to cases of empty and non-empty arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const match = Array.match({
* onEmpty: () => "empty",
* onNonEmpty: ([head, ...tail]) => `head: ${head}, tail: ${tail.length}`
* })
* console.log(match([])) // "empty"
* console.log(match([1, 2, 3])) // "head: 1, tail: 2"
* ```
*
* @category pattern matching
* @since 2.0.0
*/
export const match: {
/**
* Matches the elements of an array, applying functions to cases of empty and non-empty arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const match = Array.match({
* onEmpty: () => "empty",
* onNonEmpty: ([head, ...tail]) => `head: ${head}, tail: ${tail.length}`
* })
* console.log(match([])) // "empty"
* console.log(match([1, 2, 3])) // "head: 1, tail: 2"
* ```
*
* @category pattern matching
* @since 2.0.0
*/
<B, A, C = B>(
options: {
readonly onEmpty: LazyArg<B>
readonly onNonEmpty: (self: NonEmptyReadonlyArray<A>) => C
}
): (self: ReadonlyArray<A>) => B | C
/**
* Matches the elements of an array, applying functions to cases of empty and non-empty arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const match = Array.match({
* onEmpty: () => "empty",
* onNonEmpty: ([head, ...tail]) => `head: ${head}, tail: ${tail.length}`
* })
* console.log(match([])) // "empty"
* console.log(match([1, 2, 3])) // "head: 1, tail: 2"
* ```
*
* @category pattern matching
* @since 2.0.0
*/
<A, B, C = B>(
self: ReadonlyArray<A>,
options: {
readonly onEmpty: LazyArg<B>
readonly onNonEmpty: (self: NonEmptyReadonlyArray<A>) => C
}
): B | C
} = dual(2, <A, B, C = B>(
self: ReadonlyArray<A>,
{ onEmpty, onNonEmpty }: {
readonly onEmpty: LazyArg<B>
readonly onNonEmpty: (self: NonEmptyReadonlyArray<A>) => C
}
): B | C => isNonEmptyReadonlyArray(self) ? onNonEmpty(self) : onEmpty())
/**
* Matches the elements of an array from the left, applying functions to cases of empty and non-empty arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const matchLeft = Array.matchLeft({
* onEmpty: () => "empty",
* onNonEmpty: (head, tail) => `head: ${head}, tail: ${tail.length}`
* })
* console.log(matchLeft([])) // "empty"
* console.log(matchLeft([1, 2, 3])) // "head: 1, tail: 2"
* ```
*
* @category pattern matching
* @since 2.0.0
*/
export const matchLeft: {
/**
* Matches the elements of an array from the left, applying functions to cases of empty and non-empty arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const matchLeft = Array.matchLeft({
* onEmpty: () => "empty",
* onNonEmpty: (head, tail) => `head: ${head}, tail: ${tail.length}`
* })
* console.log(matchLeft([])) // "empty"
* console.log(matchLeft([1, 2, 3])) // "head: 1, tail: 2"
* ```
*
* @category pattern matching
* @since 2.0.0
*/
<B, A, C = B>(
options: {
readonly onEmpty: LazyArg<B>
readonly onNonEmpty: (head: A, tail: Array<A>) => C
}
): (self: ReadonlyArray<A>) => B | C
/**
* Matches the elements of an array from the left, applying functions to cases of empty and non-empty arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const matchLeft = Array.matchLeft({
* onEmpty: () => "empty",
* onNonEmpty: (head, tail) => `head: ${head}, tail: ${tail.length}`
* })
* console.log(matchLeft([])) // "empty"
* console.log(matchLeft([1, 2, 3])) // "head: 1, tail: 2"
* ```
*
* @category pattern matching
* @since 2.0.0
*/
<A, B, C = B>(
self: ReadonlyArray<A>,
options: {
readonly onEmpty: LazyArg<B>
readonly onNonEmpty: (head: A, tail: Array<A>) => C
}
): B | C
} = dual(2, <A, B, C = B>(
self: ReadonlyArray<A>,
{ onEmpty, onNonEmpty }: {
readonly onEmpty: LazyArg<B>
readonly onNonEmpty: (head: A, tail: Array<A>) => C
}
): B | C => isNonEmptyReadonlyArray(self) ? onNonEmpty(headNonEmpty(self), tailNonEmpty(self)) : onEmpty())
/**
* Matches the elements of an array from the right, applying functions to cases of empty and non-empty arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const matchRight = Array.matchRight({
* onEmpty: () => "empty",
* onNonEmpty: (init, last) => `init: ${init.length}, last: ${last}`
* })
* console.log(matchRight([])) // "empty"
* console.log(matchRight([1, 2, 3])) // "init: 2, last: 3"
* ```
*
* @category pattern matching
* @since 2.0.0
*/
export const matchRight: {
/**
* Matches the elements of an array from the right, applying functions to cases of empty and non-empty arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const matchRight = Array.matchRight({
* onEmpty: () => "empty",
* onNonEmpty: (init, last) => `init: ${init.length}, last: ${last}`
* })
* console.log(matchRight([])) // "empty"
* console.log(matchRight([1, 2, 3])) // "init: 2, last: 3"
* ```
*
* @category pattern matching
* @since 2.0.0
*/
<B, A, C = B>(
options: {
readonly onEmpty: LazyArg<B>
readonly onNonEmpty: (init: Array<A>, last: A) => C
}
): (self: ReadonlyArray<A>) => B | C
/**
* Matches the elements of an array from the right, applying functions to cases of empty and non-empty arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const matchRight = Array.matchRight({
* onEmpty: () => "empty",
* onNonEmpty: (init, last) => `init: ${init.length}, last: ${last}`
* })
* console.log(matchRight([])) // "empty"
* console.log(matchRight([1, 2, 3])) // "init: 2, last: 3"
* ```
*
* @category pattern matching
* @since 2.0.0
*/
<A, B, C = B>(
self: ReadonlyArray<A>,
options: {
readonly onEmpty: LazyArg<B>
readonly onNonEmpty: (init: Array<A>, last: A) => C
}
): B | C
} = dual(2, <A, B, C = B>(
self: ReadonlyArray<A>,
{ onEmpty, onNonEmpty }: {
readonly onEmpty: LazyArg<B>
readonly onNonEmpty: (init: Array<A>, last: A) => C
}
): B | C =>
isNonEmptyReadonlyArray(self) ?
onNonEmpty(initNonEmpty(self), lastNonEmpty(self)) :
onEmpty())
/**
* Prepend an element to the front of an `Iterable`, creating a new `NonEmptyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.prepend([2, 3, 4], 1)
* console.log(result) // [1, 2, 3, 4]
* ```
*
* @category concatenating
* @since 2.0.0
*/
export const prepend: {
/**
* Prepend an element to the front of an `Iterable`, creating a new `NonEmptyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.prepend([2, 3, 4], 1)
* console.log(result) // [1, 2, 3, 4]
* ```
*
* @category concatenating
* @since 2.0.0
*/
<B>(head: B): <A>(self: Iterable<A>) => NonEmptyArray<A | B>
/**
* Prepend an element to the front of an `Iterable`, creating a new `NonEmptyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.prepend([2, 3, 4], 1)
* console.log(result) // [1, 2, 3, 4]
* ```
*
* @category concatenating
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, head: B): NonEmptyArray<A | B>
} = dual(2, <A, B>(self: Iterable<A>, head: B): NonEmptyArray<A | B> => [head, ...self])
/**
* Prepends the specified prefix array (or iterable) to the beginning of the specified array (or iterable).
* If either array is non-empty, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.prependAll([2, 3], [0, 1])
* console.log(result) // [0, 1, 2, 3]
* ```
*
* @category concatenating
* @since 2.0.0
*/
export const prependAll: {
/**
* Prepends the specified prefix array (or iterable) to the beginning of the specified array (or iterable).
* If either array is non-empty, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.prependAll([2, 3], [0, 1])
* console.log(result) // [0, 1, 2, 3]
* ```
*
* @category concatenating
* @since 2.0.0
*/
<S extends Iterable<any>, T extends Iterable<any>>(that: T): (self: S) => ReadonlyArray.OrNonEmpty<S, T, ReadonlyArray.Infer<S> | ReadonlyArray.Infer<T>>
/**
* Prepends the specified prefix array (or iterable) to the beginning of the specified array (or iterable).
* If either array is non-empty, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.prependAll([2, 3], [0, 1])
* console.log(result) // [0, 1, 2, 3]
* ```
*
* @category concatenating
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, that: NonEmptyReadonlyArray<B>): NonEmptyArray<A | B>
/**
* Prepends the specified prefix array (or iterable) to the beginning of the specified array (or iterable).
* If either array is non-empty, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.prependAll([2, 3], [0, 1])
* console.log(result) // [0, 1, 2, 3]
* ```
*
* @category concatenating
* @since 2.0.0
*/
<A, B>(self: NonEmptyReadonlyArray<A>, that: Iterable<B>): NonEmptyArray<A | B>
/**
* Prepends the specified prefix array (or iterable) to the beginning of the specified array (or iterable).
* If either array is non-empty, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.prependAll([2, 3], [0, 1])
* console.log(result) // [0, 1, 2, 3]
* ```
*
* @category concatenating
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, that: Iterable<B>): Array<A | B>
} = dual(
2,
<A>(self: Iterable<A>, that: Iterable<A>): Array<A> => fromIterable(that).concat(fromIterable(self))
)
/**
* Append an element to the end of an `Iterable`, creating a new `NonEmptyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.append([1, 2, 3], 4);
* console.log(result) // [1, 2, 3, 4]
* ```
*
* @category concatenating
* @since 2.0.0
*/
export const append: {
/**
* Append an element to the end of an `Iterable`, creating a new `NonEmptyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.append([1, 2, 3], 4);
* console.log(result) // [1, 2, 3, 4]
* ```
*
* @category concatenating
* @since 2.0.0
*/
<B>(last: B): <A>(self: Iterable<A>) => NonEmptyArray<A | B>
/**
* Append an element to the end of an `Iterable`, creating a new `NonEmptyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.append([1, 2, 3], 4);
* console.log(result) // [1, 2, 3, 4]
* ```
*
* @category concatenating
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, last: B): NonEmptyArray<A | B>
} = dual(2, <A, B>(self: Iterable<A>, last: B): Array<A | B> => [...self, last])
/**
* Concatenates two arrays (or iterables), combining their elements.
* If either array is non-empty, the result is also a non-empty array.
*
* @category concatenating
* @since 2.0.0
*/
export const appendAll: {
/**
* Concatenates two arrays (or iterables), combining their elements.
* If either array is non-empty, the result is also a non-empty array.
*
* @category concatenating
* @since 2.0.0
*/
<S extends Iterable<any>, T extends Iterable<any>>(that: T): (self: S) => ReadonlyArray.OrNonEmpty<S, T, ReadonlyArray.Infer<S> | ReadonlyArray.Infer<T>>
/**
* Concatenates two arrays (or iterables), combining their elements.
* If either array is non-empty, the result is also a non-empty array.
*
* @category concatenating
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, that: NonEmptyReadonlyArray<B>): NonEmptyArray<A | B>
/**
* Concatenates two arrays (or iterables), combining their elements.
* If either array is non-empty, the result is also a non-empty array.
*
* @category concatenating
* @since 2.0.0
*/
<A, B>(self: NonEmptyReadonlyArray<A>, that: Iterable<B>): NonEmptyArray<A | B>
/**
* Concatenates two arrays (or iterables), combining their elements.
* If either array is non-empty, the result is also a non-empty array.
*
* @category concatenating
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, that: Iterable<B>): Array<A | B>
} = dual(
2,
<A>(self: Iterable<A>, that: Iterable<A>): Array<A> => fromIterable(self).concat(fromIterable(that))
)
/**
* Accumulates values from an `Iterable` starting from the left, storing
* each intermediate result in an array. Useful for tracking the progression of
* a value through a series of transformations.
*
* **Example**
*
* ```ts
* import { Array } from "effect";
*
* const result = Array.scan([1, 2, 3, 4], 0, (acc, value) => acc + value)
* console.log(result) // [0, 1, 3, 6, 10]
*
* // Explanation:
* // This function starts with the initial value (0 in this case)
* // and adds each element of the array to this accumulator one by one,
* // keeping track of the cumulative sum after each addition.
* // Each of these sums is captured in the resulting array.
* ```
*
* @category folding
* @since 2.0.0
*/
export const scan: {
/**
* Accumulates values from an `Iterable` starting from the left, storing
* each intermediate result in an array. Useful for tracking the progression of
* a value through a series of transformations.
*
* **Example**
*
* ```ts
* import { Array } from "effect";
*
* const result = Array.scan([1, 2, 3, 4], 0, (acc, value) => acc + value)
* console.log(result) // [0, 1, 3, 6, 10]
*
* // Explanation:
* // This function starts with the initial value (0 in this case)
* // and adds each element of the array to this accumulator one by one,
* // keeping track of the cumulative sum after each addition.
* // Each of these sums is captured in the resulting array.
* ```
*
* @category folding
* @since 2.0.0
*/
<B, A>(b: B, f: (b: B, a: A) => B): (self: Iterable<A>) => NonEmptyArray<B>
/**
* Accumulates values from an `Iterable` starting from the left, storing
* each intermediate result in an array. Useful for tracking the progression of
* a value through a series of transformations.
*
* **Example**
*
* ```ts
* import { Array } from "effect";
*
* const result = Array.scan([1, 2, 3, 4], 0, (acc, value) => acc + value)
* console.log(result) // [0, 1, 3, 6, 10]
*
* // Explanation:
* // This function starts with the initial value (0 in this case)
* // and adds each element of the array to this accumulator one by one,
* // keeping track of the cumulative sum after each addition.
* // Each of these sums is captured in the resulting array.
* ```
*
* @category folding
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, b: B, f: (b: B, a: A) => B): NonEmptyArray<B>
} = dual(3, <A, B>(self: Iterable<A>, b: B, f: (b: B, a: A) => B): NonEmptyArray<B> => {
const out: NonEmptyArray<B> = [b]
let i = 0
for (const a of self) {
out[i + 1] = f(out[i], a)
i++
}
return out
})
/**
* Accumulates values from an `Iterable` starting from the right, storing
* each intermediate result in an array. Useful for tracking the progression of
* a value through a series of transformations.
*
* **Example**
*
* ```ts
* import { Array } from "effect";
*
* const result = Array.scanRight([1, 2, 3, 4], 0, (acc, value) => acc + value)
* console.log(result) // [10, 9, 7, 4, 0]
* ```
*
* @category folding
* @since 2.0.0
*/
export const scanRight: {
/**
* Accumulates values from an `Iterable` starting from the right, storing
* each intermediate result in an array. Useful for tracking the progression of
* a value through a series of transformations.
*
* **Example**
*
* ```ts
* import { Array } from "effect";
*
* const result = Array.scanRight([1, 2, 3, 4], 0, (acc, value) => acc + value)
* console.log(result) // [10, 9, 7, 4, 0]
* ```
*
* @category folding
* @since 2.0.0
*/
<B, A>(b: B, f: (b: B, a: A) => B): (self: Iterable<A>) => NonEmptyArray<B>
/**
* Accumulates values from an `Iterable` starting from the right, storing
* each intermediate result in an array. Useful for tracking the progression of
* a value through a series of transformations.
*
* **Example**
*
* ```ts
* import { Array } from "effect";
*
* const result = Array.scanRight([1, 2, 3, 4], 0, (acc, value) => acc + value)
* console.log(result) // [10, 9, 7, 4, 0]
* ```
*
* @category folding
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, b: B, f: (b: B, a: A) => B): NonEmptyArray<B>
} = dual(3, <A, B>(self: Iterable<A>, b: B, f: (b: B, a: A) => B): NonEmptyArray<B> => {
const input = fromIterable(self)
const out: NonEmptyArray<B> = new Array(input.length + 1) as any
out[input.length] = b
for (let i = input.length - 1; i >= 0; i--) {
out[i] = f(out[i + 1], input[i])
}
return out
})
/**
* Determine if `unknown` is an Array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* console.log(Array.isArray(null)) // false
* console.log(Array.isArray([1, 2, 3])) // true
* ```
*
* @category guards
* @since 2.0.0
*/
export const isArray: {
/**
* Determine if `unknown` is an Array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* console.log(Array.isArray(null)) // false
* console.log(Array.isArray([1, 2, 3])) // true
* ```
*
* @category guards
* @since 2.0.0
*/
(self: unknown): self is Array<unknown>
/**
* Determine if `unknown` is an Array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* console.log(Array.isArray(null)) // false
* console.log(Array.isArray([1, 2, 3])) // true
* ```
*
* @category guards
* @since 2.0.0
*/
<T>(self: T): self is Extract<T, ReadonlyArray<any>>
} = Array.isArray
/**
* Determine if an `Array` is empty narrowing down the type to `[]`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* console.log(Array.isEmptyArray([])) // true
* console.log(Array.isEmptyArray([1, 2, 3])) // false
* ```
*
* @category guards
* @since 2.0.0
*/
export const isEmptyArray = <A>(self: Array<A>): self is [] => self.length === 0
/**
* Determine if a `ReadonlyArray` is empty narrowing down the type to `readonly []`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* console.log(Array.isEmptyReadonlyArray([])) // true
* console.log(Array.isEmptyReadonlyArray([1, 2, 3])) // false
* ```
*
* @category guards
* @since 2.0.0
*/
export const isEmptyReadonlyArray: <A>(self: ReadonlyArray<A>) => self is readonly [] = isEmptyArray as any
/**
* Determine if an `Array` is non empty narrowing down the type to `NonEmptyArray`.
*
* An `Array` is considered to be a `NonEmptyArray` if it contains at least one element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* console.log(Array.isNonEmptyArray([])) // false
* console.log(Array.isNonEmptyArray([1, 2, 3])) // true
* ```
*
* @category guards
* @since 2.0.0
*/
export const isNonEmptyArray: <A>(self: Array<A>) => self is NonEmptyArray<A> = internalArray.isNonEmptyArray
/**
* Determine if a `ReadonlyArray` is non empty narrowing down the type to `NonEmptyReadonlyArray`.
*
* A `ReadonlyArray` is considered to be a `NonEmptyReadonlyArray` if it contains at least one element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* console.log(Array.isNonEmptyReadonlyArray([])) // false
* console.log(Array.isNonEmptyReadonlyArray([1, 2, 3])) // true
* ```
*
* @category guards
* @since 2.0.0
*/
export const isNonEmptyReadonlyArray: <A>(self: ReadonlyArray<A>) => self is NonEmptyReadonlyArray<A> =
internalArray.isNonEmptyArray
/**
* Return the number of elements in a `ReadonlyArray`.
*
* @category getters
* @since 2.0.0
*/
export const length = <A>(self: ReadonlyArray<A>): number => self.length
const isOutOfBounds = <A>(i: number, as: ReadonlyArray<A>): boolean => i < 0 || i >= as.length
const clamp = <A>(i: number, as: ReadonlyArray<A>): number => Math.floor(Math.min(Math.max(0, i), as.length))
/**
* This function provides a safe way to read a value at a particular index from a `ReadonlyArray`.
*
* @category getters
* @since 2.0.0
*/
export const get: {
/**
* This function provides a safe way to read a value at a particular index from a `ReadonlyArray`.
*
* @category getters
* @since 2.0.0
*/
(index: number): <A>(self: ReadonlyArray<A>) => Option.Option<A>
/**
* This function provides a safe way to read a value at a particular index from a `ReadonlyArray`.
*
* @category getters
* @since 2.0.0
*/
<A>(self: ReadonlyArray<A>, index: number): Option.Option<A>
} = dual(2, <A>(self: ReadonlyArray<A>, index: number): Option.Option<A> => {
const i = Math.floor(index)
return isOutOfBounds(i, self) ? Option.none() : Option.some(self[i])
})
/**
* Gets an element unsafely, will throw on out of bounds.
*
* @since 2.0.0
* @category unsafe
*/
export const unsafeGet: {
/**
* Gets an element unsafely, will throw on out of bounds.
*
* @since 2.0.0
* @category unsafe
*/
(index: number): <A>(self: ReadonlyArray<A>) => A
/**
* Gets an element unsafely, will throw on out of bounds.
*
* @since 2.0.0
* @category unsafe
*/
<A>(self: ReadonlyArray<A>, index: number): A
} = dual(2, <A>(self: ReadonlyArray<A>, index: number): A => {
const i = Math.floor(index)
if (isOutOfBounds(i, self)) {
throw new Error(`Index ${i} out of bounds`)
}
return self[i]
})
/**
* Return a tuple containing the first element, and a new `Array` of the remaining elements, if any.
*
* **Example**
*
* ```ts
* import { Array } from "effect";
*
* const result = Array.unprepend([1, 2, 3, 4])
* console.log(result) // [1, [2, 3, 4]]
* ```
*
* @category splitting
* @since 2.0.0
*/
export const unprepend = <A>(
self: NonEmptyReadonlyArray<A>
): [firstElement: A, remainingElements: Array<A>] => [headNonEmpty(self), tailNonEmpty(self)]
/**
* Return a tuple containing a copy of the `NonEmptyReadonlyArray` without its last element, and that last element.
*
* **Example**
*
* ```ts
* import { Array } from "effect";
*
* const result = Array.unappend([1, 2, 3, 4])
* console.log(result) // [[1, 2, 3], 4]
* ```
*
* @category splitting
* @since 2.0.0
*/
export const unappend = <A>(
self: NonEmptyReadonlyArray<A>
): [arrayWithoutLastElement: Array<A>, lastElement: A] => [initNonEmpty(self), lastNonEmpty(self)]
/**
* Get the first element of a `ReadonlyArray`, or `None` if the `ReadonlyArray` is empty.
*
* @category getters
* @since 2.0.0
*/
export const head: <A>(self: ReadonlyArray<A>) => Option.Option<A> = get(0)
/**
* Get the first element of a non empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.headNonEmpty([1, 2, 3, 4])
* console.log(result) // 1
* ```
*
* @category getters
* @since 2.0.0
*/
export const headNonEmpty: <A>(self: NonEmptyReadonlyArray<A>) => A = unsafeGet(0)
/**
* Get the last element in a `ReadonlyArray`, or `None` if the `ReadonlyArray` is empty.
*
* @category getters
* @since 2.0.0
*/
export const last = <A>(self: ReadonlyArray<A>): Option.Option<A> =>
isNonEmptyReadonlyArray(self) ? Option.some(lastNonEmpty(self)) : Option.none()
/**
* Get the last element of a non empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.lastNonEmpty([1, 2, 3, 4])
* console.log(result) // 4
* ```
*
* @category getters
* @since 2.0.0
*/
export const lastNonEmpty = <A>(self: NonEmptyReadonlyArray<A>): A => self[self.length - 1]
/**
* Get all but the first element of an `Iterable`, creating a new `Array`, or `None` if the `Iterable` is empty.
*
* @category getters
* @since 2.0.0
*/
export const tail = <A>(self: Iterable<A>): Option.Option<Array<A>> => {
const input = fromIterable(self)
return isNonEmptyReadonlyArray(input) ? Option.some(tailNonEmpty(input)) : Option.none()
}
/**
* Get all but the first element of a `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.tailNonEmpty([1, 2, 3, 4])
* console.log(result) // [2, 3, 4]
* ```
*
* @category getters
* @since 2.0.0
*/
export const tailNonEmpty = <A>(self: NonEmptyReadonlyArray<A>): Array<A> => self.slice(1)
/**
* Get all but the last element of an `Iterable`, creating a new `Array`, or `None` if the `Iterable` is empty.
*
* @category getters
* @since 2.0.0
*/
export const init = <A>(self: Iterable<A>): Option.Option<Array<A>> => {
const input = fromIterable(self)
return isNonEmptyReadonlyArray(input) ? Option.some(initNonEmpty(input)) : Option.none()
}
/**
* Get all but the last element of a non empty array, creating a new array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.initNonEmpty([1, 2, 3, 4])
* console.log(result) // [1, 2, 3]
* ```
*
* @category getters
* @since 2.0.0
*/
export const initNonEmpty = <A>(self: NonEmptyReadonlyArray<A>): Array<A> => self.slice(0, -1)
/**
* Keep only a max number of elements from the start of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.take([1, 2, 3, 4, 5], 3)
* console.log(result) // [1, 2, 3]
* ```
*
* @category getters
* @since 2.0.0
*/
export const take: {
/**
* Keep only a max number of elements from the start of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.take([1, 2, 3, 4, 5], 3)
* console.log(result) // [1, 2, 3]
* ```
*
* @category getters
* @since 2.0.0
*/
(n: number): <A>(self: Iterable<A>) => Array<A>
/**
* Keep only a max number of elements from the start of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.take([1, 2, 3, 4, 5], 3)
* console.log(result) // [1, 2, 3]
* ```
*
* @category getters
* @since 2.0.0
*/
<A>(self: Iterable<A>, n: number): Array<A>
} = dual(2, <A>(self: Iterable<A>, n: number): Array<A> => {
const input = fromIterable(self)
return input.slice(0, clamp(n, input))
})
/**
* Keep only a max number of elements from the end of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.takeRight([1, 2, 3, 4, 5], 3)
* console.log(result) // [3, 4, 5]
* ```
*
* @category getters
* @since 2.0.0
*/
export const takeRight: {
/**
* Keep only a max number of elements from the end of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.takeRight([1, 2, 3, 4, 5], 3)
* console.log(result) // [3, 4, 5]
* ```
*
* @category getters
* @since 2.0.0
*/
(n: number): <A>(self: Iterable<A>) => Array<A>
/**
* Keep only a max number of elements from the end of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.takeRight([1, 2, 3, 4, 5], 3)
* console.log(result) // [3, 4, 5]
* ```
*
* @category getters
* @since 2.0.0
*/
<A>(self: Iterable<A>, n: number): Array<A>
} = dual(2, <A>(self: Iterable<A>, n: number): Array<A> => {
const input = fromIterable(self)
const i = clamp(n, input)
return i === 0 ? [] : input.slice(-i)
})
/**
* Calculate the longest initial subarray for which all element satisfy the specified predicate, creating a new `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.takeWhile([1, 3, 2, 4, 1, 2], x => x < 4)
* console.log(result) // [1, 3, 2]
*
* // Explanation:
* // - The function starts with the first element (`1`), which is less than `4`, so it adds `1` to the result.
* // - The next element (`3`) is also less than `4`, so it adds `3`.
* // - The next element (`2`) is again less than `4`, so it adds `2`.
* // - The function then encounters `4`, which is not less than `4`. At this point, it stops checking further elements and finalizes the result.
* ```
*
* @category getters
* @since 2.0.0
*/
export const takeWhile: {
/**
* Calculate the longest initial subarray for which all element satisfy the specified predicate, creating a new `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.takeWhile([1, 3, 2, 4, 1, 2], x => x < 4)
* console.log(result) // [1, 3, 2]
*
* // Explanation:
* // - The function starts with the first element (`1`), which is less than `4`, so it adds `1` to the result.
* // - The next element (`3`) is also less than `4`, so it adds `3`.
* // - The next element (`2`) is again less than `4`, so it adds `2`.
* // - The function then encounters `4`, which is not less than `4`. At this point, it stops checking further elements and finalizes the result.
* ```
*
* @category getters
* @since 2.0.0
*/
<A, B extends A>(refinement: (a: NoInfer<A>, i: number) => a is B): (self: Iterable<A>) => Array<B>
/**
* Calculate the longest initial subarray for which all element satisfy the specified predicate, creating a new `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.takeWhile([1, 3, 2, 4, 1, 2], x => x < 4)
* console.log(result) // [1, 3, 2]
*
* // Explanation:
* // - The function starts with the first element (`1`), which is less than `4`, so it adds `1` to the result.
* // - The next element (`3`) is also less than `4`, so it adds `3`.
* // - The next element (`2`) is again less than `4`, so it adds `2`.
* // - The function then encounters `4`, which is not less than `4`. At this point, it stops checking further elements and finalizes the result.
* ```
*
* @category getters
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => Array<A>
/**
* Calculate the longest initial subarray for which all element satisfy the specified predicate, creating a new `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.takeWhile([1, 3, 2, 4, 1, 2], x => x < 4)
* console.log(result) // [1, 3, 2]
*
* // Explanation:
* // - The function starts with the first element (`1`), which is less than `4`, so it adds `1` to the result.
* // - The next element (`3`) is also less than `4`, so it adds `3`.
* // - The next element (`2`) is again less than `4`, so it adds `2`.
* // - The function then encounters `4`, which is not less than `4`. At this point, it stops checking further elements and finalizes the result.
* ```
*
* @category getters
* @since 2.0.0
*/
<A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): Array<B>
/**
* Calculate the longest initial subarray for which all element satisfy the specified predicate, creating a new `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.takeWhile([1, 3, 2, 4, 1, 2], x => x < 4)
* console.log(result) // [1, 3, 2]
*
* // Explanation:
* // - The function starts with the first element (`1`), which is less than `4`, so it adds `1` to the result.
* // - The next element (`3`) is also less than `4`, so it adds `3`.
* // - The next element (`2`) is again less than `4`, so it adds `2`.
* // - The function then encounters `4`, which is not less than `4`. At this point, it stops checking further elements and finalizes the result.
* ```
*
* @category getters
* @since 2.0.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A>
} = dual(2, <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A> => {
let i = 0
const out: Array<A> = []
for (const a of self) {
if (!predicate(a, i)) {
break
}
out.push(a)
i++
}
return out
})
const spanIndex = <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): number => {
let i = 0
for (const a of self) {
if (!predicate(a, i)) {
break
}
i++
}
return i
}
/**
* Split an `Iterable` into two parts:
*
* 1. the longest initial subarray for which all elements satisfy the specified predicate
* 2. the remaining elements
*
* @category splitting
* @since 2.0.0
*/
export const span: {
/**
* Split an `Iterable` into two parts:
*
* 1. the longest initial subarray for which all elements satisfy the specified predicate
* 2. the remaining elements
*
* @category splitting
* @since 2.0.0
*/
<A, B extends A>(refinement: (a: NoInfer<A>, i: number) => a is B): (self: Iterable<A>) => [init: Array<B>, rest: Array<Exclude<A, B>>]
/**
* Split an `Iterable` into two parts:
*
* 1. the longest initial subarray for which all elements satisfy the specified predicate
* 2. the remaining elements
*
* @category splitting
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => [init: Array<A>, rest: Array<A>]
/**
* Split an `Iterable` into two parts:
*
* 1. the longest initial subarray for which all elements satisfy the specified predicate
* 2. the remaining elements
*
* @category splitting
* @since 2.0.0
*/
<A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): [init: Array<B>, rest: Array<Exclude<A, B>>]
/**
* Split an `Iterable` into two parts:
*
* 1. the longest initial subarray for which all elements satisfy the specified predicate
* 2. the remaining elements
*
* @category splitting
* @since 2.0.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): [init: Array<A>, rest: Array<A>]
} = dual(
2,
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): [init: Array<A>, rest: Array<A>] =>
splitAt(self, spanIndex(self, predicate))
)
/**
* Drop a max number of elements from the start of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.drop([1, 2, 3, 4, 5], 2)
* console.log(result) // [3, 4, 5]
* ```
*
* @category getters
* @since 2.0.0
*/
export const drop: {
/**
* Drop a max number of elements from the start of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.drop([1, 2, 3, 4, 5], 2)
* console.log(result) // [3, 4, 5]
* ```
*
* @category getters
* @since 2.0.0
*/
(n: number): <A>(self: Iterable<A>) => Array<A>
/**
* Drop a max number of elements from the start of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.drop([1, 2, 3, 4, 5], 2)
* console.log(result) // [3, 4, 5]
* ```
*
* @category getters
* @since 2.0.0
*/
<A>(self: Iterable<A>, n: number): Array<A>
} = dual(2, <A>(self: Iterable<A>, n: number): Array<A> => {
const input = fromIterable(self)
return input.slice(clamp(n, input), input.length)
})
/**
* Drop a max number of elements from the end of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dropRight([1, 2, 3, 4, 5], 2)
* console.log(result) // [1, 2, 3]
* ```
*
* @category getters
* @since 2.0.0
*/
export const dropRight: {
/**
* Drop a max number of elements from the end of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dropRight([1, 2, 3, 4, 5], 2)
* console.log(result) // [1, 2, 3]
* ```
*
* @category getters
* @since 2.0.0
*/
(n: number): <A>(self: Iterable<A>) => Array<A>
/**
* Drop a max number of elements from the end of an `Iterable`, creating a new `Array`.
*
* **Note**. `n` is normalized to a non negative integer.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dropRight([1, 2, 3, 4, 5], 2)
* console.log(result) // [1, 2, 3]
* ```
*
* @category getters
* @since 2.0.0
*/
<A>(self: Iterable<A>, n: number): Array<A>
} = dual(2, <A>(self: Iterable<A>, n: number): Array<A> => {
const input = fromIterable(self)
return input.slice(0, input.length - clamp(n, input))
})
/**
* Remove the longest initial subarray for which all element satisfy the specified predicate, creating a new `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dropWhile([1, 2, 3, 4, 5], x => x < 4)
* console.log(result) // [4, 5]
* ```
*
* @category getters
* @since 2.0.0
*/
export const dropWhile: {
/**
* Remove the longest initial subarray for which all element satisfy the specified predicate, creating a new `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dropWhile([1, 2, 3, 4, 5], x => x < 4)
* console.log(result) // [4, 5]
* ```
*
* @category getters
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => Array<A>
/**
* Remove the longest initial subarray for which all element satisfy the specified predicate, creating a new `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dropWhile([1, 2, 3, 4, 5], x => x < 4)
* console.log(result) // [4, 5]
* ```
*
* @category getters
* @since 2.0.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A>
} = dual(
2,
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A> =>
fromIterable(self).slice(spanIndex(self, predicate))
)
/**
* Return the first index for which a predicate holds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findFirstIndex([5, 3, 8, 9], x => x > 5)
* console.log(result) // Option.some(2)
* ```
*
* @category elements
* @since 2.0.0
*/
export const findFirstIndex: {
/**
* Return the first index for which a predicate holds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findFirstIndex([5, 3, 8, 9], x => x > 5)
* console.log(result) // Option.some(2)
* ```
*
* @category elements
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => Option.Option<number>
/**
* Return the first index for which a predicate holds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findFirstIndex([5, 3, 8, 9], x => x > 5)
* console.log(result) // Option.some(2)
* ```
*
* @category elements
* @since 2.0.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Option.Option<number>
} = dual(2, <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Option.Option<number> => {
let i = 0
for (const a of self) {
if (predicate(a, i)) {
return Option.some(i)
}
i++
}
return Option.none()
})
/**
* Return the last index for which a predicate holds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findLastIndex([1, 3, 8, 9], x => x < 5)
* console.log(result) // Option.some(1)
* ```
*
* @category elements
* @since 2.0.0
*/
export const findLastIndex: {
/**
* Return the last index for which a predicate holds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findLastIndex([1, 3, 8, 9], x => x < 5)
* console.log(result) // Option.some(1)
* ```
*
* @category elements
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => Option.Option<number>
/**
* Return the last index for which a predicate holds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findLastIndex([1, 3, 8, 9], x => x < 5)
* console.log(result) // Option.some(1)
* ```
*
* @category elements
* @since 2.0.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Option.Option<number>
} = dual(2, <A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Option.Option<number> => {
const input = fromIterable(self)
for (let i = input.length - 1; i >= 0; i--) {
if (predicate(input[i], i)) {
return Option.some(i)
}
}
return Option.none()
})
/**
* Returns the first element that satisfies the specified
* predicate, or `None` if no such element exists.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findFirst([1, 2, 3, 4, 5], x => x > 3)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
export const findFirst: {
/**
* Returns the first element that satisfies the specified
* predicate, or `None` if no such element exists.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findFirst([1, 2, 3, 4, 5], x => x > 3)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A, B>(f: (a: NoInfer<A>, i: number) => Option.Option<B>): (self: Iterable<A>) => Option.Option<B>
/**
* Returns the first element that satisfies the specified
* predicate, or `None` if no such element exists.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findFirst([1, 2, 3, 4, 5], x => x > 3)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A, B extends A>(refinement: (a: NoInfer<A>, i: number) => a is B): (self: Iterable<A>) => Option.Option<B>
/**
* Returns the first element that satisfies the specified
* predicate, or `None` if no such element exists.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findFirst([1, 2, 3, 4, 5], x => x > 3)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => Option.Option<A>
/**
* Returns the first element that satisfies the specified
* predicate, or `None` if no such element exists.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findFirst([1, 2, 3, 4, 5], x => x > 3)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, f: (a: A, i: number) => Option.Option<B>): Option.Option<B>
/**
* Returns the first element that satisfies the specified
* predicate, or `None` if no such element exists.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findFirst([1, 2, 3, 4, 5], x => x > 3)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): Option.Option<B>
/**
* Returns the first element that satisfies the specified
* predicate, or `None` if no such element exists.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findFirst([1, 2, 3, 4, 5], x => x > 3)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Option.Option<A>
} = moduleIterable.findFirst
/**
* Finds the last element in an iterable collection that satisfies the given predicate or refinement.
* Returns an `Option` containing the found element, or `Option.none` if no element matches.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findLast([1, 2, 3, 4, 5], n => n % 2 === 0)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
export const findLast: {
/**
* Finds the last element in an iterable collection that satisfies the given predicate or refinement.
* Returns an `Option` containing the found element, or `Option.none` if no element matches.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findLast([1, 2, 3, 4, 5], n => n % 2 === 0)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A, B>(f: (a: NoInfer<A>, i: number) => Option.Option<B>): (self: Iterable<A>) => Option.Option<B>
/**
* Finds the last element in an iterable collection that satisfies the given predicate or refinement.
* Returns an `Option` containing the found element, or `Option.none` if no element matches.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findLast([1, 2, 3, 4, 5], n => n % 2 === 0)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A, B extends A>(refinement: (a: NoInfer<A>, i: number) => a is B): (self: Iterable<A>) => Option.Option<B>
/**
* Finds the last element in an iterable collection that satisfies the given predicate or refinement.
* Returns an `Option` containing the found element, or `Option.none` if no element matches.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findLast([1, 2, 3, 4, 5], n => n % 2 === 0)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => Option.Option<A>
/**
* Finds the last element in an iterable collection that satisfies the given predicate or refinement.
* Returns an `Option` containing the found element, or `Option.none` if no element matches.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findLast([1, 2, 3, 4, 5], n => n % 2 === 0)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, f: (a: A, i: number) => Option.Option<B>): Option.Option<B>
/**
* Finds the last element in an iterable collection that satisfies the given predicate or refinement.
* Returns an `Option` containing the found element, or `Option.none` if no element matches.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findLast([1, 2, 3, 4, 5], n => n % 2 === 0)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): Option.Option<B>
/**
* Finds the last element in an iterable collection that satisfies the given predicate or refinement.
* Returns an `Option` containing the found element, or `Option.none` if no element matches.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.findLast([1, 2, 3, 4, 5], n => n % 2 === 0)
* console.log(result) // Option.some(4)
* ```
*
* @category elements
* @since 2.0.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Option.Option<A>
} = dual(
2,
<A>(
self: Iterable<A>,
f: ((a: A, i: number) => boolean) | ((a: A, i: number) => Option.Option<A>)
): Option.Option<A> => {
const input = fromIterable(self)
for (let i = input.length - 1; i >= 0; i--) {
const a = input[i]
const o = f(a, i)
if (Predicate.isBoolean(o)) {
if (o) {
return Option.some(a)
}
} else {
if (Option.isSome(o)) {
return o
}
}
}
return Option.none()
}
)
/**
* Counts all the element of the given array that pass the given predicate
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.countBy([1, 2, 3, 4, 5], n => n % 2 === 0)
* console.log(result) // 2
* ```
*
* @category folding
* @since 3.16.0
*/
export const countBy: {
/**
* Counts all the element of the given array that pass the given predicate
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.countBy([1, 2, 3, 4, 5], n => n % 2 === 0)
* console.log(result) // 2
* ```
*
* @category folding
* @since 3.16.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => number
/**
* Counts all the element of the given array that pass the given predicate
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.countBy([1, 2, 3, 4, 5], n => n % 2 === 0)
* console.log(result) // 2
* ```
*
* @category folding
* @since 3.16.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): number
} = dual(
2,
<A>(
self: Iterable<A>,
f: (a: A, i: number) => boolean
): number => {
let count = 0
const as = fromIterable(self)
for (let i = 0; i < as.length; i++) {
const a = as[i]
if (f(a, i)) {
count++
}
}
return count
}
)
/**
* Insert an element at the specified index, creating a new `NonEmptyArray`,
* or return `None` if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.insertAt(['a', 'b', 'c', 'e'], 3, 'd')
* console.log(result) // Option.some(['a', 'b', 'c', 'd', 'e'])
* ```
*
* @since 2.0.0
*/
export const insertAt: {
/**
* Insert an element at the specified index, creating a new `NonEmptyArray`,
* or return `None` if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.insertAt(['a', 'b', 'c', 'e'], 3, 'd')
* console.log(result) // Option.some(['a', 'b', 'c', 'd', 'e'])
* ```
*
* @since 2.0.0
*/
<B>(i: number, b: B): <A>(self: Iterable<A>) => Option.Option<NonEmptyArray<A | B>>
/**
* Insert an element at the specified index, creating a new `NonEmptyArray`,
* or return `None` if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.insertAt(['a', 'b', 'c', 'e'], 3, 'd')
* console.log(result) // Option.some(['a', 'b', 'c', 'd', 'e'])
* ```
*
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, i: number, b: B): Option.Option<NonEmptyArray<A | B>>
} = dual(3, <A, B>(self: Iterable<A>, i: number, b: B): Option.Option<NonEmptyArray<A | B>> => {
const out: Array<A | B> = Array.from(self)
// v--- `= self.length` is ok, it means inserting in last position
if (i < 0 || i > out.length) {
return Option.none()
}
out.splice(i, 0, b)
return Option.some(out) as any
})
/**
* Change the element at the specified index, creating a new `Array`,
* or return a copy of the input if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.replace(['a', 'b', 'c', 'd'], 1, 'z')
* console.log(result) // ['a', 'z', 'c', 'd']
* ```
*
* @since 2.0.0
*/
export const replace: {
/**
* Change the element at the specified index, creating a new `Array`,
* or return a copy of the input if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.replace(['a', 'b', 'c', 'd'], 1, 'z')
* console.log(result) // ['a', 'z', 'c', 'd']
* ```
*
* @since 2.0.0
*/
<B>(i: number, b: B): <A, S extends Iterable<A> = Iterable<A>>(
self: S
) => ReadonlyArray.With<S, ReadonlyArray.Infer<S> | B>
/**
* Change the element at the specified index, creating a new `Array`,
* or return a copy of the input if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.replace(['a', 'b', 'c', 'd'], 1, 'z')
* console.log(result) // ['a', 'z', 'c', 'd']
* ```
*
* @since 2.0.0
*/
<A, B, S extends Iterable<A> = Iterable<A>>(self: S, i: number, b: B): ReadonlyArray.With<S, ReadonlyArray.Infer<S> | B>
} = dual(3, <A, B>(self: Iterable<A>, i: number, b: B): Array<A | B> => modify(self, i, () => b))
/**
* Replaces an element in an array with the given value, returning an option of the updated array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.replaceOption([1, 2, 3], 1, 4)
* console.log(result) // Option.some([1, 4, 3])
* ```
*
* @since 2.0.0
*/
export const replaceOption: {
/**
* Replaces an element in an array with the given value, returning an option of the updated array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.replaceOption([1, 2, 3], 1, 4)
* console.log(result) // Option.some([1, 4, 3])
* ```
*
* @since 2.0.0
*/
<B>(i: number, b: B): <A, S extends Iterable<A> = Iterable<A>>(
self: S
) => Option.Option<ReadonlyArray.With<S, ReadonlyArray.Infer<S> | B>>
/**
* Replaces an element in an array with the given value, returning an option of the updated array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.replaceOption([1, 2, 3], 1, 4)
* console.log(result) // Option.some([1, 4, 3])
* ```
*
* @since 2.0.0
*/
<A, B, S extends Iterable<A> = Iterable<A>>(self: S, i: number, b: B): Option.Option<ReadonlyArray.With<S, ReadonlyArray.Infer<S> | B>>
} = dual(
3,
<A, B>(self: Iterable<A>, i: number, b: B): Option.Option<Array<A | B>> => modifyOption(self, i, () => b)
)
/**
* Apply a function to the element at the specified index, creating a new `Array`,
* or return a copy of the input if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.modify([1, 2, 3, 4], 2, (n) => n * 2)
* console.log(result) // [1, 2, 6, 4]
* ```
*
* @since 2.0.0
*/
export const modify: {
/**
* Apply a function to the element at the specified index, creating a new `Array`,
* or return a copy of the input if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.modify([1, 2, 3, 4], 2, (n) => n * 2)
* console.log(result) // [1, 2, 6, 4]
* ```
*
* @since 2.0.0
*/
<A, B, S extends Iterable<A> = Iterable<A>>(i: number, f: (a: ReadonlyArray.Infer<S>) => B): (self: S) => ReadonlyArray.With<S, ReadonlyArray.Infer<S> | B>
/**
* Apply a function to the element at the specified index, creating a new `Array`,
* or return a copy of the input if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.modify([1, 2, 3, 4], 2, (n) => n * 2)
* console.log(result) // [1, 2, 6, 4]
* ```
*
* @since 2.0.0
*/
<A, B, S extends Iterable<A> = Iterable<A>>(self: S, i: number, f: (a: ReadonlyArray.Infer<S>) => B): ReadonlyArray.With<S, ReadonlyArray.Infer<S> | B>
} = dual(
3,
<A, B>(self: Iterable<A>, i: number, f: (a: A) => B): Array<A | B> => {
const out: Array<A | B> = Array.from(self)
if (isOutOfBounds(i, out)) {
return out
}
const b = f(out[i] as A)
out[i] = b
return out
}
)
/**
* Apply a function to the element at the specified index, creating a new `Array`,
* or return `None` if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const input = [1, 2, 3, 4]
* const result = Array.modifyOption(input, 2, (n) => n * 2)
* console.log(result) // Option.some([1, 2, 6, 4])
*
* const outOfBoundsResult = Array.modifyOption(input, 5, (n) => n * 2)
* console.log(outOfBoundsResult) // Option.none()
* ```
*
* @since 2.0.0
*/
export const modifyOption: {
/**
* Apply a function to the element at the specified index, creating a new `Array`,
* or return `None` if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const input = [1, 2, 3, 4]
* const result = Array.modifyOption(input, 2, (n) => n * 2)
* console.log(result) // Option.some([1, 2, 6, 4])
*
* const outOfBoundsResult = Array.modifyOption(input, 5, (n) => n * 2)
* console.log(outOfBoundsResult) // Option.none()
* ```
*
* @since 2.0.0
*/
<A, B, S extends Iterable<A> = Iterable<A>>(i: number, f: (a: ReadonlyArray.Infer<S>) => B): (self: S) => Option.Option<ReadonlyArray.With<S, ReadonlyArray.Infer<S> | B>>
/**
* Apply a function to the element at the specified index, creating a new `Array`,
* or return `None` if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const input = [1, 2, 3, 4]
* const result = Array.modifyOption(input, 2, (n) => n * 2)
* console.log(result) // Option.some([1, 2, 6, 4])
*
* const outOfBoundsResult = Array.modifyOption(input, 5, (n) => n * 2)
* console.log(outOfBoundsResult) // Option.none()
* ```
*
* @since 2.0.0
*/
<A, B, S extends Iterable<A> = Iterable<A>>(self: S, i: number, f: (a: ReadonlyArray.Infer<S>) => B): Option.Option<ReadonlyArray.With<S, ReadonlyArray.Infer<S> | B>>
} = dual(3, <A, B>(self: Iterable<A>, i: number, f: (a: A) => B): Option.Option<Array<A | B>> => {
const arr = fromIterable(self)
if (isOutOfBounds(i, arr)) {
return Option.none()
}
const out: Array<A | B> = Array.isArray(self) ? self.slice() : arr
const b = f(arr[i])
out[i] = b
return Option.some(out)
})
/**
* Delete the element at the specified index, creating a new `Array`,
* or return a copy of the input if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const input = [1, 2, 3, 4]
* const result = Array.remove(input, 2)
* console.log(result) // [1, 2, 4]
*
* const outOfBoundsResult = Array.remove(input, 5)
* console.log(outOfBoundsResult) // [1, 2, 3, 4]
* ```
*
* @since 2.0.0
*/
export const remove: {
/**
* Delete the element at the specified index, creating a new `Array`,
* or return a copy of the input if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const input = [1, 2, 3, 4]
* const result = Array.remove(input, 2)
* console.log(result) // [1, 2, 4]
*
* const outOfBoundsResult = Array.remove(input, 5)
* console.log(outOfBoundsResult) // [1, 2, 3, 4]
* ```
*
* @since 2.0.0
*/
(i: number): <A>(self: Iterable<A>) => Array<A>
/**
* Delete the element at the specified index, creating a new `Array`,
* or return a copy of the input if the index is out of bounds.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const input = [1, 2, 3, 4]
* const result = Array.remove(input, 2)
* console.log(result) // [1, 2, 4]
*
* const outOfBoundsResult = Array.remove(input, 5)
* console.log(outOfBoundsResult) // [1, 2, 3, 4]
* ```
*
* @since 2.0.0
*/
<A>(self: Iterable<A>, i: number): Array<A>
} = dual(2, <A>(self: Iterable<A>, i: number): Array<A> => {
const out = Array.from(self)
if (isOutOfBounds(i, out)) {
return out
}
out.splice(i, 1)
return out
})
/**
* Delete the element at the specified index, creating a new `Array`,
* or return `None` if the index is out of bounds.
*
* @example
* ```ts
* import * as assert from "node:assert"
* import { Array, Option } from "effect"
*
* const numbers = [1, 2, 3, 4]
* const result = Array.removeOption(numbers, 2)
* assert.deepStrictEqual(result, Option.some([1, 2, 4]))
*
* const outOfBoundsResult = Array.removeOption(numbers, 5)
* assert.deepStrictEqual(outOfBoundsResult, Option.none())
* ```
*
* @since 3.16.0
*/
export const removeOption: {
/**
* Delete the element at the specified index, creating a new `Array`,
* or return `None` if the index is out of bounds.
*
* @example
* ```ts
* import * as assert from "node:assert"
* import { Array, Option } from "effect"
*
* const numbers = [1, 2, 3, 4]
* const result = Array.removeOption(numbers, 2)
* assert.deepStrictEqual(result, Option.some([1, 2, 4]))
*
* const outOfBoundsResult = Array.removeOption(numbers, 5)
* assert.deepStrictEqual(outOfBoundsResult, Option.none())
* ```
*
* @since 3.16.0
*/
(i: number): <A>(self: Iterable<A>) => Option.Option<Array<A>>
/**
* Delete the element at the specified index, creating a new `Array`,
* or return `None` if the index is out of bounds.
*
* @example
* ```ts
* import * as assert from "node:assert"
* import { Array, Option } from "effect"
*
* const numbers = [1, 2, 3, 4]
* const result = Array.removeOption(numbers, 2)
* assert.deepStrictEqual(result, Option.some([1, 2, 4]))
*
* const outOfBoundsResult = Array.removeOption(numbers, 5)
* assert.deepStrictEqual(outOfBoundsResult, Option.none())
* ```
*
* @since 3.16.0
*/
<A>(self: Iterable<A>, i: number): Option.Option<Array<A>>
} = dual(2, <A>(self: Iterable<A>, i: number): Option.Option<Array<A>> => {
const arr = fromIterable(self)
if (isOutOfBounds(i, arr)) {
return Option.none()
}
const out = Array.isArray(self) ? self.slice() : arr
out.splice(i, 1)
return Option.some(out)
})
/**
* Reverse an `Iterable`, creating a new `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.reverse([1, 2, 3, 4])
* console.log(result) // [4, 3, 2, 1]
* ```
*
* @category elements
* @since 2.0.0
*/
export const reverse = <S extends Iterable<any>>(
self: S
): S extends NonEmptyReadonlyArray<infer A> ? NonEmptyArray<A> : S extends Iterable<infer A> ? Array<A> : never =>
Array.from(self).reverse() as any
/**
* Create a new array with elements sorted in increasing order based on the specified comparator.
* If the input is a `NonEmptyReadonlyArray`, the output will also be a `NonEmptyReadonlyArray`.
*
* @category sorting
* @since 2.0.0
*/
export const sort: {
/**
* Create a new array with elements sorted in increasing order based on the specified comparator.
* If the input is a `NonEmptyReadonlyArray`, the output will also be a `NonEmptyReadonlyArray`.
*
* @category sorting
* @since 2.0.0
*/
<B>(O: Order.Order<B>): <A extends B, S extends Iterable<A>>(self: S) => ReadonlyArray.With<S, ReadonlyArray.Infer<S>>
/**
* Create a new array with elements sorted in increasing order based on the specified comparator.
* If the input is a `NonEmptyReadonlyArray`, the output will also be a `NonEmptyReadonlyArray`.
*
* @category sorting
* @since 2.0.0
*/
<A extends B, B>(self: NonEmptyReadonlyArray<A>, O: Order.Order<B>): NonEmptyArray<A>
/**
* Create a new array with elements sorted in increasing order based on the specified comparator.
* If the input is a `NonEmptyReadonlyArray`, the output will also be a `NonEmptyReadonlyArray`.
*
* @category sorting
* @since 2.0.0
*/
<A extends B, B>(self: Iterable<A>, O: Order.Order<B>): Array<A>
} = dual(2, <A extends B, B>(self: Iterable<A>, O: Order.Order<B>): Array<A> => {
const out = Array.from(self)
out.sort(O)
return out
})
/**
* Sorts an array based on a provided mapping function and order. The mapping
* function transforms the elements into a value that can be compared, and the
* order defines how those values should be sorted.
*
* **Example**
*
* ```ts
* import { Array, Order } from "effect"
*
* const result = Array.sortWith(["aaa", "b", "cc"], (s) => s.length, Order.number)
* console.log(result) // ["b", "cc", "aaa"]
*
* // Explanation:
* // The array of strings is sorted based on their lengths. The mapping function `(s) => s.length`
* // converts each string into its length, and the `Order.number` specifies that the lengths should
* // be sorted in ascending order.
* ```
*
* @since 2.0.0
* @category elements
*/
export const sortWith: {
/**
* Sorts an array based on a provided mapping function and order. The mapping
* function transforms the elements into a value that can be compared, and the
* order defines how those values should be sorted.
*
* **Example**
*
* ```ts
* import { Array, Order } from "effect"
*
* const result = Array.sortWith(["aaa", "b", "cc"], (s) => s.length, Order.number)
* console.log(result) // ["b", "cc", "aaa"]
*
* // Explanation:
* // The array of strings is sorted based on their lengths. The mapping function `(s) => s.length`
* // converts each string into its length, and the `Order.number` specifies that the lengths should
* // be sorted in ascending order.
* ```
*
* @since 2.0.0
* @category elements
*/
<S extends Iterable<any>, B>(f: (a: ReadonlyArray.Infer<S>) => B, order: Order.Order<B>): (self: S) => ReadonlyArray.With<S, ReadonlyArray.Infer<S>>
/**
* Sorts an array based on a provided mapping function and order. The mapping
* function transforms the elements into a value that can be compared, and the
* order defines how those values should be sorted.
*
* **Example**
*
* ```ts
* import { Array, Order } from "effect"
*
* const result = Array.sortWith(["aaa", "b", "cc"], (s) => s.length, Order.number)
* console.log(result) // ["b", "cc", "aaa"]
*
* // Explanation:
* // The array of strings is sorted based on their lengths. The mapping function `(s) => s.length`
* // converts each string into its length, and the `Order.number` specifies that the lengths should
* // be sorted in ascending order.
* ```
*
* @since 2.0.0
* @category elements
*/
<A, B>(self: NonEmptyReadonlyArray<A>, f: (a: A) => B, O: Order.Order<B>): NonEmptyArray<A>
/**
* Sorts an array based on a provided mapping function and order. The mapping
* function transforms the elements into a value that can be compared, and the
* order defines how those values should be sorted.
*
* **Example**
*
* ```ts
* import { Array, Order } from "effect"
*
* const result = Array.sortWith(["aaa", "b", "cc"], (s) => s.length, Order.number)
* console.log(result) // ["b", "cc", "aaa"]
*
* // Explanation:
* // The array of strings is sorted based on their lengths. The mapping function `(s) => s.length`
* // converts each string into its length, and the `Order.number` specifies that the lengths should
* // be sorted in ascending order.
* ```
*
* @since 2.0.0
* @category elements
*/
<A, B>(self: Iterable<A>, f: (a: A) => B, order: Order.Order<B>): Array<A>
} = dual(
3,
<A, B>(self: Iterable<A>, f: (a: A) => B, order: Order.Order<B>): Array<A> =>
Array.from(self).map((a) => [a, f(a)] as const).sort(([, a], [, b]) => order(a, b)).map(([_]) => _)
)
/**
* Sorts the elements of an `Iterable` in increasing order based on the provided
* orders. The elements are compared using the first order in `orders`, then the
* second order if the first comparison is equal, and so on.
*
* **Example**
*
* ```ts
* import { Array, Order, pipe } from "effect"
*
* const users = [
* { name: "Alice", age: 30 },
* { name: "Bob", age: 25 },
* { name: "Charlie", age: 30 }
* ]
*
* const result = pipe(
* users,
* Array.sortBy(
* Order.mapInput(Order.number, (user: (typeof users)[number]) => user.age),
* Order.mapInput(Order.string, (user: (typeof users)[number]) => user.name)
* )
* )
*
* console.log(result)
* // [
* // { name: "Bob", age: 25 },
* // { name: "Alice", age: 30 },
* // { name: "Charlie", age: 30 }
* // ]
*
* // Explanation:
* // The array of users is sorted first by age in ascending order. When ages are equal,
* // the users are further sorted by name in ascending order.
* ```
*
* @category sorting
* @since 2.0.0
*/
export const sortBy = <S extends Iterable<any>>(
...orders: ReadonlyArray<Order.Order<ReadonlyArray.Infer<S>>>
) => {
const sortByAll = sort(Order.combineAll(orders))
return (
self: S
): S extends NonEmptyReadonlyArray<infer A> ? NonEmptyArray<A> : S extends Iterable<infer A> ? Array<A> : never => {
const input = fromIterable(self)
if (isNonEmptyReadonlyArray(input)) {
return sortByAll(input) as any
}
return [] as any
}
}
/**
* Takes two `Iterable`s and returns an `Array` of corresponding pairs.
* If one input `Iterable` is short, excess elements of the
* longer `Iterable` are discarded.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.zip([1, 2, 3], ['a', 'b'])
* console.log(result) // [[1, 'a'], [2, 'b']]
* ```
*
* @category zipping
* @since 2.0.0
*/
export const zip: {
/**
* Takes two `Iterable`s and returns an `Array` of corresponding pairs.
* If one input `Iterable` is short, excess elements of the
* longer `Iterable` are discarded.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.zip([1, 2, 3], ['a', 'b'])
* console.log(result) // [[1, 'a'], [2, 'b']]
* ```
*
* @category zipping
* @since 2.0.0
*/
<B>(that: NonEmptyReadonlyArray<B>): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<[A, B]>
/**
* Takes two `Iterable`s and returns an `Array` of corresponding pairs.
* If one input `Iterable` is short, excess elements of the
* longer `Iterable` are discarded.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.zip([1, 2, 3], ['a', 'b'])
* console.log(result) // [[1, 'a'], [2, 'b']]
* ```
*
* @category zipping
* @since 2.0.0
*/
<B>(that: Iterable<B>): <A>(self: Iterable<A>) => Array<[A, B]>
/**
* Takes two `Iterable`s and returns an `Array` of corresponding pairs.
* If one input `Iterable` is short, excess elements of the
* longer `Iterable` are discarded.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.zip([1, 2, 3], ['a', 'b'])
* console.log(result) // [[1, 'a'], [2, 'b']]
* ```
*
* @category zipping
* @since 2.0.0
*/
<A, B>(self: NonEmptyReadonlyArray<A>, that: NonEmptyReadonlyArray<B>): NonEmptyArray<[A, B]>
/**
* Takes two `Iterable`s and returns an `Array` of corresponding pairs.
* If one input `Iterable` is short, excess elements of the
* longer `Iterable` are discarded.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.zip([1, 2, 3], ['a', 'b'])
* console.log(result) // [[1, 'a'], [2, 'b']]
* ```
*
* @category zipping
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, that: Iterable<B>): Array<[A, B]>
} = dual(
2,
<A, B>(self: Iterable<A>, that: Iterable<B>): Array<[A, B]> => zipWith(self, that, Tuple.make)
)
/**
* Apply a function to pairs of elements at the same index in two `Iterable`s, collecting the results in a new `Array`. If one
* input `Iterable` is short, excess elements of the longer `Iterable` are discarded.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.zipWith([1, 2, 3], [4, 5, 6], (a, b) => a + b)
* console.log(result) // [5, 7, 9]
* ```
*
* @category zipping
* @since 2.0.0
*/
export const zipWith: {
/**
* Apply a function to pairs of elements at the same index in two `Iterable`s, collecting the results in a new `Array`. If one
* input `Iterable` is short, excess elements of the longer `Iterable` are discarded.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.zipWith([1, 2, 3], [4, 5, 6], (a, b) => a + b)
* console.log(result) // [5, 7, 9]
* ```
*
* @category zipping
* @since 2.0.0
*/
<B, A, C>(that: NonEmptyReadonlyArray<B>, f: (a: A, b: B) => C): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<C>
/**
* Apply a function to pairs of elements at the same index in two `Iterable`s, collecting the results in a new `Array`. If one
* input `Iterable` is short, excess elements of the longer `Iterable` are discarded.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.zipWith([1, 2, 3], [4, 5, 6], (a, b) => a + b)
* console.log(result) // [5, 7, 9]
* ```
*
* @category zipping
* @since 2.0.0
*/
<B, A, C>(that: Iterable<B>, f: (a: A, b: B) => C): (self: Iterable<A>) => Array<C>
/**
* Apply a function to pairs of elements at the same index in two `Iterable`s, collecting the results in a new `Array`. If one
* input `Iterable` is short, excess elements of the longer `Iterable` are discarded.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.zipWith([1, 2, 3], [4, 5, 6], (a, b) => a + b)
* console.log(result) // [5, 7, 9]
* ```
*
* @category zipping
* @since 2.0.0
*/
<A, B, C>(
self: NonEmptyReadonlyArray<A>,
that: NonEmptyReadonlyArray<B>,
f: (a: A, b: B) => C
): NonEmptyArray<C>
/**
* Apply a function to pairs of elements at the same index in two `Iterable`s, collecting the results in a new `Array`. If one
* input `Iterable` is short, excess elements of the longer `Iterable` are discarded.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.zipWith([1, 2, 3], [4, 5, 6], (a, b) => a + b)
* console.log(result) // [5, 7, 9]
* ```
*
* @category zipping
* @since 2.0.0
*/
<B, A, C>(self: Iterable<A>, that: Iterable<B>, f: (a: A, b: B) => C): Array<C>
} = dual(3, <B, A, C>(self: Iterable<A>, that: Iterable<B>, f: (a: A, b: B) => C): Array<C> => {
const as = fromIterable(self)
const bs = fromIterable(that)
if (isNonEmptyReadonlyArray(as) && isNonEmptyReadonlyArray(bs)) {
const out: NonEmptyArray<C> = [f(headNonEmpty(as), headNonEmpty(bs))]
const len = Math.min(as.length, bs.length)
for (let i = 1; i < len; i++) {
out[i] = f(as[i], bs[i])
}
return out
}
return []
})
/**
* This function is the inverse of `zip`. Takes an `Iterable` of pairs and return two corresponding `Array`s.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.unzip([[1, "a"], [2, "b"], [3, "c"]])
* console.log(result) // [[1, 2, 3], ['a', 'b', 'c']]
* ```
*
* @since 2.0.0
*/
export const unzip: <S extends Iterable<readonly [any, any]>>(
self: S
) => S extends NonEmptyReadonlyArray<readonly [infer A, infer B]> ? [NonEmptyArray<A>, NonEmptyArray<B>]
: S extends Iterable<readonly [infer A, infer B]> ? [Array<A>, Array<B>]
: never = (<A, B>(self: Iterable<readonly [A, B]>): [Array<A>, Array<B>] => {
const input = fromIterable(self)
if (isNonEmptyReadonlyArray(input)) {
const fa: NonEmptyArray<A> = [input[0][0]]
const fb: NonEmptyArray<B> = [input[0][1]]
for (let i = 1; i < input.length; i++) {
fa[i] = input[i][0]
fb[i] = input[i][1]
}
return [fa, fb]
}
return [[], []]
}) as any
/**
* Places an element in between members of an `Iterable`.
* If the input is a non-empty array, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.intersperse([1, 2, 3], 0)
* console.log(result) // [1, 0, 2, 0, 3]
* ```
*
* @since 2.0.0
*/
export const intersperse: {
/**
* Places an element in between members of an `Iterable`.
* If the input is a non-empty array, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.intersperse([1, 2, 3], 0)
* console.log(result) // [1, 0, 2, 0, 3]
* ```
*
* @since 2.0.0
*/
<B>(middle: B): <S extends Iterable<any>>(self: S) => ReadonlyArray.With<S, ReadonlyArray.Infer<S> | B>
/**
* Places an element in between members of an `Iterable`.
* If the input is a non-empty array, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.intersperse([1, 2, 3], 0)
* console.log(result) // [1, 0, 2, 0, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(self: NonEmptyReadonlyArray<A>, middle: B): NonEmptyArray<A | B>
/**
* Places an element in between members of an `Iterable`.
* If the input is a non-empty array, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.intersperse([1, 2, 3], 0)
* console.log(result) // [1, 0, 2, 0, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, middle: B): Array<A | B>
} = dual(2, <A, B>(self: Iterable<A>, middle: B): Array<A | B> => {
const input = fromIterable(self)
if (isNonEmptyReadonlyArray(input)) {
const out: NonEmptyArray<A | B> = [headNonEmpty(input)]
const tail = tailNonEmpty(input)
for (let i = 0; i < tail.length; i++) {
if (i < tail.length) {
out.push(middle)
}
out.push(tail[i])
}
return out
}
return []
})
/**
* Apply a function to the head, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.modifyNonEmptyHead([1, 2, 3], n => n * 10)
* console.log(result) // [10, 2, 3]
* ```
*
* @since 2.0.0
*/
export const modifyNonEmptyHead: {
/**
* Apply a function to the head, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.modifyNonEmptyHead([1, 2, 3], n => n * 10)
* console.log(result) // [10, 2, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(f: (a: A) => B): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>
/**
* Apply a function to the head, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.modifyNonEmptyHead([1, 2, 3], n => n * 10)
* console.log(result) // [10, 2, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(self: NonEmptyReadonlyArray<A>, f: (a: A) => B): NonEmptyArray<A | B>
} = dual(
2,
<A, B>(
self: NonEmptyReadonlyArray<A>,
f: (a: A) => B
): NonEmptyArray<A | B> => [f(headNonEmpty(self)), ...tailNonEmpty(self)]
)
/**
* Change the head, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.setNonEmptyHead([1, 2, 3], 10)
* console.log(result) // [10, 2, 3]
* ```
*
* @since 2.0.0
*/
export const setNonEmptyHead: {
/**
* Change the head, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.setNonEmptyHead([1, 2, 3], 10)
* console.log(result) // [10, 2, 3]
* ```
*
* @since 2.0.0
*/
<B>(b: B): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>
/**
* Change the head, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.setNonEmptyHead([1, 2, 3], 10)
* console.log(result) // [10, 2, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(self: NonEmptyReadonlyArray<A>, b: B): NonEmptyArray<A | B>
} = dual(
2,
<A, B>(self: NonEmptyReadonlyArray<A>, b: B): NonEmptyArray<A | B> => modifyNonEmptyHead(self, () => b)
)
/**
* Apply a function to the last element, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.modifyNonEmptyLast([1, 2, 3], n => n * 2)
* console.log(result) // [1, 2, 6]
* ```
*
* @since 2.0.0
*/
export const modifyNonEmptyLast: {
/**
* Apply a function to the last element, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.modifyNonEmptyLast([1, 2, 3], n => n * 2)
* console.log(result) // [1, 2, 6]
* ```
*
* @since 2.0.0
*/
<A, B>(f: (a: A) => B): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>
/**
* Apply a function to the last element, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.modifyNonEmptyLast([1, 2, 3], n => n * 2)
* console.log(result) // [1, 2, 6]
* ```
*
* @since 2.0.0
*/
<A, B>(self: NonEmptyReadonlyArray<A>, f: (a: A) => B): NonEmptyArray<A | B>
} = dual(
2,
<A, B>(self: NonEmptyReadonlyArray<A>, f: (a: A) => B): NonEmptyArray<A | B> =>
append(initNonEmpty(self), f(lastNonEmpty(self)))
)
/**
* Change the last element, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.setNonEmptyLast([1, 2, 3], 4)
* console.log(result) // [1, 2, 4]
* ```
*
* @since 2.0.0
*/
export const setNonEmptyLast: {
/**
* Change the last element, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.setNonEmptyLast([1, 2, 3], 4)
* console.log(result) // [1, 2, 4]
* ```
*
* @since 2.0.0
*/
<B>(b: B): <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<A | B>
/**
* Change the last element, creating a new `NonEmptyReadonlyArray`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.setNonEmptyLast([1, 2, 3], 4)
* console.log(result) // [1, 2, 4]
* ```
*
* @since 2.0.0
*/
<A, B>(self: NonEmptyReadonlyArray<A>, b: B): NonEmptyArray<A | B>
} = dual(
2,
<A, B>(self: NonEmptyReadonlyArray<A>, b: B): NonEmptyArray<A | B> => modifyNonEmptyLast(self, () => b)
)
/**
* Rotate an `Iterable` by `n` steps.
* If the input is a non-empty array, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.rotate(['a', 'b', 'c', 'd'], 2)
* console.log(result) // ['c', 'd', 'a', 'b']
* ```
*
* @since 2.0.0
*/
export const rotate: {
/**
* Rotate an `Iterable` by `n` steps.
* If the input is a non-empty array, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.rotate(['a', 'b', 'c', 'd'], 2)
* console.log(result) // ['c', 'd', 'a', 'b']
* ```
*
* @since 2.0.0
*/
(n: number): <S extends Iterable<any>>(self: S) => ReadonlyArray.With<S, ReadonlyArray.Infer<S>>
/**
* Rotate an `Iterable` by `n` steps.
* If the input is a non-empty array, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.rotate(['a', 'b', 'c', 'd'], 2)
* console.log(result) // ['c', 'd', 'a', 'b']
* ```
*
* @since 2.0.0
*/
<A>(self: NonEmptyReadonlyArray<A>, n: number): NonEmptyArray<A>
/**
* Rotate an `Iterable` by `n` steps.
* If the input is a non-empty array, the result is also a non-empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.rotate(['a', 'b', 'c', 'd'], 2)
* console.log(result) // ['c', 'd', 'a', 'b']
* ```
*
* @since 2.0.0
*/
<A>(self: Iterable<A>, n: number): Array<A>
} = dual(2, <A>(self: Iterable<A>, n: number): Array<A> => {
const input = fromIterable(self)
if (isNonEmptyReadonlyArray(input)) {
const len = input.length
const m = Math.round(n) % len
if (isOutOfBounds(Math.abs(m), input) || m === 0) {
return copy(input)
}
if (m < 0) {
const [f, s] = splitNonEmptyAt(input, -m)
return appendAll(s, f)
} else {
return rotate(self, m - len)
}
}
return []
})
/**
* Returns a function that checks if a `ReadonlyArray` contains a given value using a provided `isEquivalent` function.
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const isEquivalent = (a: number, b: number) => a === b
* const containsNumber = Array.containsWith(isEquivalent)
* const result = pipe([1, 2, 3, 4], containsNumber(3))
* console.log(result) // true
* ```
*
* @category elements
* @since 2.0.0
*/
export const containsWith = <A>(isEquivalent: (self: A, that: A) => boolean): {
(a: A): (self: Iterable<A>) => boolean
(self: Iterable<A>, a: A): boolean
} =>
dual(2, (self: Iterable<A>, a: A): boolean => {
for (const i of self) {
if (isEquivalent(a, i)) {
return true
}
}
return false
})
const _equivalence = Equal.equivalence()
/**
* Returns a function that checks if a `ReadonlyArray` contains a given value using the default `Equivalence`.
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const result = pipe(['a', 'b', 'c', 'd'], Array.contains('c'))
* console.log(result) // true
* ```
*
* @category elements
* @since 2.0.0
*/
export const contains: {
/**
* Returns a function that checks if a `ReadonlyArray` contains a given value using the default `Equivalence`.
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const result = pipe(['a', 'b', 'c', 'd'], Array.contains('c'))
* console.log(result) // true
* ```
*
* @category elements
* @since 2.0.0
*/
<A>(a: A): (self: Iterable<A>) => boolean
/**
* Returns a function that checks if a `ReadonlyArray` contains a given value using the default `Equivalence`.
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const result = pipe(['a', 'b', 'c', 'd'], Array.contains('c'))
* console.log(result) // true
* ```
*
* @category elements
* @since 2.0.0
*/
<A>(self: Iterable<A>, a: A): boolean
} = containsWith(_equivalence)
/**
* A useful recursion pattern for processing an `Iterable` to produce a new `Array`, often used for "chopping" up the input
* `Iterable`. Typically chop is called with some function that will consume an initial prefix of the `Iterable` and produce a
* value and the rest of the `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.chop([1, 2, 3, 4, 5], (as): [number, Array<number>] => [as[0] * 2, as.slice(1)])
* console.log(result) // [2, 4, 6, 8, 10]
*
* // Explanation:
* // The `chopFunction` takes the first element of the array, doubles it, and then returns it along with the rest of the array.
* // The `chop` function applies this `chopFunction` recursively to the input array `[1, 2, 3, 4, 5]`,
* // resulting in a new array `[2, 4, 6, 8, 10]`.
* ```
*
* @since 2.0.0
*/
export const chop: {
/**
* A useful recursion pattern for processing an `Iterable` to produce a new `Array`, often used for "chopping" up the input
* `Iterable`. Typically chop is called with some function that will consume an initial prefix of the `Iterable` and produce a
* value and the rest of the `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.chop([1, 2, 3, 4, 5], (as): [number, Array<number>] => [as[0] * 2, as.slice(1)])
* console.log(result) // [2, 4, 6, 8, 10]
*
* // Explanation:
* // The `chopFunction` takes the first element of the array, doubles it, and then returns it along with the rest of the array.
* // The `chop` function applies this `chopFunction` recursively to the input array `[1, 2, 3, 4, 5]`,
* // resulting in a new array `[2, 4, 6, 8, 10]`.
* ```
*
* @since 2.0.0
*/
<S extends Iterable<any>, B>(
f: (as: NonEmptyReadonlyArray<ReadonlyArray.Infer<S>>) => readonly [B, ReadonlyArray<ReadonlyArray.Infer<S>>]
): (self: S) => ReadonlyArray.With<S, ReadonlyArray.Infer<S>>
/**
* A useful recursion pattern for processing an `Iterable` to produce a new `Array`, often used for "chopping" up the input
* `Iterable`. Typically chop is called with some function that will consume an initial prefix of the `Iterable` and produce a
* value and the rest of the `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.chop([1, 2, 3, 4, 5], (as): [number, Array<number>] => [as[0] * 2, as.slice(1)])
* console.log(result) // [2, 4, 6, 8, 10]
*
* // Explanation:
* // The `chopFunction` takes the first element of the array, doubles it, and then returns it along with the rest of the array.
* // The `chop` function applies this `chopFunction` recursively to the input array `[1, 2, 3, 4, 5]`,
* // resulting in a new array `[2, 4, 6, 8, 10]`.
* ```
*
* @since 2.0.0
*/
<A, B>(
self: NonEmptyReadonlyArray<A>,
f: (as: NonEmptyReadonlyArray<A>) => readonly [B, ReadonlyArray<A>]
): NonEmptyArray<B>
/**
* A useful recursion pattern for processing an `Iterable` to produce a new `Array`, often used for "chopping" up the input
* `Iterable`. Typically chop is called with some function that will consume an initial prefix of the `Iterable` and produce a
* value and the rest of the `Array`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.chop([1, 2, 3, 4, 5], (as): [number, Array<number>] => [as[0] * 2, as.slice(1)])
* console.log(result) // [2, 4, 6, 8, 10]
*
* // Explanation:
* // The `chopFunction` takes the first element of the array, doubles it, and then returns it along with the rest of the array.
* // The `chop` function applies this `chopFunction` recursively to the input array `[1, 2, 3, 4, 5]`,
* // resulting in a new array `[2, 4, 6, 8, 10]`.
* ```
*
* @since 2.0.0
*/
<A, B>(
self: Iterable<A>,
f: (as: NonEmptyReadonlyArray<A>) => readonly [B, ReadonlyArray<A>]
): Array<B>
} = dual(2, <A, B>(
self: Iterable<A>,
f: (as: NonEmptyReadonlyArray<A>) => readonly [B, ReadonlyArray<A>]
): Array<B> => {
const input = fromIterable(self)
if (isNonEmptyReadonlyArray(input)) {
const [b, rest] = f(input)
const out: NonEmptyArray<B> = [b]
let next: ReadonlyArray<A> = rest
while (internalArray.isNonEmptyArray(next)) {
const [b, rest] = f(next)
out.push(b)
next = rest
}
return out
}
return []
})
/**
* Splits an `Iterable` into two segments, with the first segment containing a maximum of `n` elements.
* The value of `n` can be `0`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.splitAt([1, 2, 3, 4, 5], 3)
* console.log(result) // [[1, 2, 3], [4, 5]]
* ```
*
* @category splitting
* @since 2.0.0
*/
export const splitAt: {
/**
* Splits an `Iterable` into two segments, with the first segment containing a maximum of `n` elements.
* The value of `n` can be `0`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.splitAt([1, 2, 3, 4, 5], 3)
* console.log(result) // [[1, 2, 3], [4, 5]]
* ```
*
* @category splitting
* @since 2.0.0
*/
(n: number): <A>(self: Iterable<A>) => [beforeIndex: Array<A>, fromIndex: Array<A>]
/**
* Splits an `Iterable` into two segments, with the first segment containing a maximum of `n` elements.
* The value of `n` can be `0`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.splitAt([1, 2, 3, 4, 5], 3)
* console.log(result) // [[1, 2, 3], [4, 5]]
* ```
*
* @category splitting
* @since 2.0.0
*/
<A>(self: Iterable<A>, n: number): [beforeIndex: Array<A>, fromIndex: Array<A>]
} = dual(2, <A>(self: Iterable<A>, n: number): [Array<A>, Array<A>] => {
const input = Array.from(self)
const _n = Math.floor(n)
if (isNonEmptyReadonlyArray(input)) {
if (_n >= 1) {
return splitNonEmptyAt(input, _n)
}
return [[], input]
}
return [input, []]
})
/**
* Splits a `NonEmptyReadonlyArray` into two segments, with the first segment containing a maximum of `n` elements.
* The value of `n` must be `>= 1`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.splitNonEmptyAt(["a", "b", "c", "d", "e"], 3)
* console.log(result) // [["a", "b", "c"], ["d", "e"]]
* ```
*
* @category splitting
* @since 2.0.0
*/
export const splitNonEmptyAt: {
/**
* Splits a `NonEmptyReadonlyArray` into two segments, with the first segment containing a maximum of `n` elements.
* The value of `n` must be `>= 1`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.splitNonEmptyAt(["a", "b", "c", "d", "e"], 3)
* console.log(result) // [["a", "b", "c"], ["d", "e"]]
* ```
*
* @category splitting
* @since 2.0.0
*/
(n: number): <A>(self: NonEmptyReadonlyArray<A>) => [beforeIndex: NonEmptyArray<A>, fromIndex: Array<A>]
/**
* Splits a `NonEmptyReadonlyArray` into two segments, with the first segment containing a maximum of `n` elements.
* The value of `n` must be `>= 1`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.splitNonEmptyAt(["a", "b", "c", "d", "e"], 3)
* console.log(result) // [["a", "b", "c"], ["d", "e"]]
* ```
*
* @category splitting
* @since 2.0.0
*/
<A>(self: NonEmptyReadonlyArray<A>, n: number): [beforeIndex: NonEmptyArray<A>, fromIndex: Array<A>]
} = dual(2, <A>(self: NonEmptyReadonlyArray<A>, n: number): [NonEmptyArray<A>, Array<A>] => {
const _n = Math.max(1, Math.floor(n))
return _n >= self.length ?
[copy(self), []] :
[prepend(self.slice(1, _n), headNonEmpty(self)), self.slice(_n)]
})
/**
* Splits this iterable into `n` equally sized arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.split([1, 2, 3, 4, 5, 6, 7, 8], 3)
* console.log(result) // [[1, 2, 3], [4, 5, 6], [7, 8]]
* ```
*
* @since 2.0.0
* @category splitting
*/
export const split: {
/**
* Splits this iterable into `n` equally sized arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.split([1, 2, 3, 4, 5, 6, 7, 8], 3)
* console.log(result) // [[1, 2, 3], [4, 5, 6], [7, 8]]
* ```
*
* @since 2.0.0
* @category splitting
*/
(n: number): <A>(self: Iterable<A>) => Array<Array<A>>
/**
* Splits this iterable into `n` equally sized arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.split([1, 2, 3, 4, 5, 6, 7, 8], 3)
* console.log(result) // [[1, 2, 3], [4, 5, 6], [7, 8]]
* ```
*
* @since 2.0.0
* @category splitting
*/
<A>(self: Iterable<A>, n: number): Array<Array<A>>
} = dual(2, <A>(self: Iterable<A>, n: number) => {
const input = fromIterable(self)
return chunksOf(input, Math.ceil(input.length / Math.floor(n)))
})
/**
* Splits this iterable on the first element that matches this predicate.
* Returns a tuple containing two arrays: the first one is before the match, and the second one is from the match onward.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.splitWhere([1, 2, 3, 4, 5], n => n > 3)
* console.log(result) // [[1, 2, 3], [4, 5]]
* ```
*
* @category splitting
* @since 2.0.0
*/
export const splitWhere: {
/**
* Splits this iterable on the first element that matches this predicate.
* Returns a tuple containing two arrays: the first one is before the match, and the second one is from the match onward.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.splitWhere([1, 2, 3, 4, 5], n => n > 3)
* console.log(result) // [[1, 2, 3], [4, 5]]
* ```
*
* @category splitting
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => [beforeMatch: Array<A>, fromMatch: Array<A>]
/**
* Splits this iterable on the first element that matches this predicate.
* Returns a tuple containing two arrays: the first one is before the match, and the second one is from the match onward.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.splitWhere([1, 2, 3, 4, 5], n => n > 3)
* console.log(result) // [[1, 2, 3], [4, 5]]
* ```
*
* @category splitting
* @since 2.0.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): [beforeMatch: Array<A>, fromMatch: Array<A>]
} = dual(
2,
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): [beforeMatch: Array<A>, fromMatch: Array<A>] =>
span(self, (a: A, i: number) => !predicate(a, i))
)
/**
* Copies an array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.copy([1, 2, 3])
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
export const copy: {
/**
* Copies an array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.copy([1, 2, 3])
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A>(self: NonEmptyReadonlyArray<A>): NonEmptyArray<A>
/**
* Copies an array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.copy([1, 2, 3])
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A>(self: ReadonlyArray<A>): Array<A>
} = (<A>(self: ReadonlyArray<A>): Array<A> => self.slice()) as any
/**
* Pads an array.
* Returns a new array of length `n` with the elements of `array` followed by `fill` elements if `array` is shorter than `n`.
* If `array` is longer than `n`, the returned array will be a slice of `array` containing the `n` first elements of `array`.
* If `n` is less than or equal to 0, the returned array will be an empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.pad([1, 2, 3], 6, 0)
* console.log(result) // [1, 2, 3, 0, 0, 0]
* ```
*
* @since 3.8.4
*/
export const pad: {
/**
* Pads an array.
* Returns a new array of length `n` with the elements of `array` followed by `fill` elements if `array` is shorter than `n`.
* If `array` is longer than `n`, the returned array will be a slice of `array` containing the `n` first elements of `array`.
* If `n` is less than or equal to 0, the returned array will be an empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.pad([1, 2, 3], 6, 0)
* console.log(result) // [1, 2, 3, 0, 0, 0]
* ```
*
* @since 3.8.4
*/
<A, T>(n: number, fill: T): (
self: Array<A>
) => Array<A | T>
/**
* Pads an array.
* Returns a new array of length `n` with the elements of `array` followed by `fill` elements if `array` is shorter than `n`.
* If `array` is longer than `n`, the returned array will be a slice of `array` containing the `n` first elements of `array`.
* If `n` is less than or equal to 0, the returned array will be an empty array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.pad([1, 2, 3], 6, 0)
* console.log(result) // [1, 2, 3, 0, 0, 0]
* ```
*
* @since 3.8.4
*/
<A, T>(self: Array<A>, n: number, fill: T): Array<A | T>
} = dual(3, <A, T>(self: Array<A>, n: number, fill: T): Array<A | T> => {
if (self.length >= n) {
return take(self, n)
}
return appendAll(
self,
makeBy(n - self.length, () => fill)
)
})
/**
* Splits an `Iterable` into length-`n` pieces. The last piece will be shorter if `n` does not evenly divide the length of
* the `Iterable`. Note that `chunksOf(n)([])` is `[]`, not `[[]]`. This is intentional, and is consistent with a recursive
* definition of `chunksOf`; it satisfies the property that
*
* ```ts skip-type-checking
* chunksOf(n)(xs).concat(chunksOf(n)(ys)) == chunksOf(n)(xs.concat(ys)))
* ```
*
* whenever `n` evenly divides the length of `self`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.chunksOf([1, 2, 3, 4, 5], 2)
* console.log(result) // [[1, 2], [3, 4], [5]]
*
* // Explanation:
* // The `chunksOf` function takes an array of numbers `[1, 2, 3, 4, 5]` and a number `2`.
* // It splits the array into chunks of length 2. Since the array length is not evenly divisible by 2,
* // the last chunk contains the remaining elements.
* // The result is `[[1, 2], [3, 4], [5]]`.
* ```
*
* @category splitting
* @since 2.0.0
*/
export const chunksOf: {
/**
* Splits an `Iterable` into length-`n` pieces. The last piece will be shorter if `n` does not evenly divide the length of
* the `Iterable`. Note that `chunksOf(n)([])` is `[]`, not `[[]]`. This is intentional, and is consistent with a recursive
* definition of `chunksOf`; it satisfies the property that
*
* ```ts skip-type-checking
* chunksOf(n)(xs).concat(chunksOf(n)(ys)) == chunksOf(n)(xs.concat(ys)))
* ```
*
* whenever `n` evenly divides the length of `self`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.chunksOf([1, 2, 3, 4, 5], 2)
* console.log(result) // [[1, 2], [3, 4], [5]]
*
* // Explanation:
* // The `chunksOf` function takes an array of numbers `[1, 2, 3, 4, 5]` and a number `2`.
* // It splits the array into chunks of length 2. Since the array length is not evenly divisible by 2,
* // the last chunk contains the remaining elements.
* // The result is `[[1, 2], [3, 4], [5]]`.
* ```
*
* @category splitting
* @since 2.0.0
*/
(n: number): <S extends Iterable<any>>(
self: S
) => ReadonlyArray.With<S, NonEmptyArray<ReadonlyArray.Infer<S>>>
/**
* Splits an `Iterable` into length-`n` pieces. The last piece will be shorter if `n` does not evenly divide the length of
* the `Iterable`. Note that `chunksOf(n)([])` is `[]`, not `[[]]`. This is intentional, and is consistent with a recursive
* definition of `chunksOf`; it satisfies the property that
*
* ```ts skip-type-checking
* chunksOf(n)(xs).concat(chunksOf(n)(ys)) == chunksOf(n)(xs.concat(ys)))
* ```
*
* whenever `n` evenly divides the length of `self`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.chunksOf([1, 2, 3, 4, 5], 2)
* console.log(result) // [[1, 2], [3, 4], [5]]
*
* // Explanation:
* // The `chunksOf` function takes an array of numbers `[1, 2, 3, 4, 5]` and a number `2`.
* // It splits the array into chunks of length 2. Since the array length is not evenly divisible by 2,
* // the last chunk contains the remaining elements.
* // The result is `[[1, 2], [3, 4], [5]]`.
* ```
*
* @category splitting
* @since 2.0.0
*/
<A>(self: NonEmptyReadonlyArray<A>, n: number): NonEmptyArray<NonEmptyArray<A>>
/**
* Splits an `Iterable` into length-`n` pieces. The last piece will be shorter if `n` does not evenly divide the length of
* the `Iterable`. Note that `chunksOf(n)([])` is `[]`, not `[[]]`. This is intentional, and is consistent with a recursive
* definition of `chunksOf`; it satisfies the property that
*
* ```ts skip-type-checking
* chunksOf(n)(xs).concat(chunksOf(n)(ys)) == chunksOf(n)(xs.concat(ys)))
* ```
*
* whenever `n` evenly divides the length of `self`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.chunksOf([1, 2, 3, 4, 5], 2)
* console.log(result) // [[1, 2], [3, 4], [5]]
*
* // Explanation:
* // The `chunksOf` function takes an array of numbers `[1, 2, 3, 4, 5]` and a number `2`.
* // It splits the array into chunks of length 2. Since the array length is not evenly divisible by 2,
* // the last chunk contains the remaining elements.
* // The result is `[[1, 2], [3, 4], [5]]`.
* ```
*
* @category splitting
* @since 2.0.0
*/
<A>(self: Iterable<A>, n: number): Array<NonEmptyArray<A>>
} = dual(2, <A>(self: Iterable<A>, n: number): Array<NonEmptyArray<A>> => {
const input = fromIterable(self)
if (isNonEmptyReadonlyArray(input)) {
return chop(input, splitNonEmptyAt(n))
}
return []
})
/**
* Creates sliding windows of size `n` from an `Iterable`.
* If the number of elements is less than `n` or if `n` is not greater than zero,
* an empty array is returned.
*
* @example
* ```ts
* import * as assert from "node:assert"
* import { Array } from "effect"
*
* const numbers = [1, 2, 3, 4, 5]
* assert.deepStrictEqual(Array.window(numbers, 3), [[1, 2, 3], [2, 3, 4], [3, 4, 5]])
* assert.deepStrictEqual(Array.window(numbers, 6), [])
* ```
*
* @category splitting
* @since 3.13.2
*/
export const window: {
/**
* Creates sliding windows of size `n` from an `Iterable`.
* If the number of elements is less than `n` or if `n` is not greater than zero,
* an empty array is returned.
*
* @example
* ```ts
* import * as assert from "node:assert"
* import { Array } from "effect"
*
* const numbers = [1, 2, 3, 4, 5]
* assert.deepStrictEqual(Array.window(numbers, 3), [[1, 2, 3], [2, 3, 4], [3, 4, 5]])
* assert.deepStrictEqual(Array.window(numbers, 6), [])
* ```
*
* @category splitting
* @since 3.13.2
*/
(n: number): <A>(self: Iterable<A>) => Array<Array<A>>
/**
* Creates sliding windows of size `n` from an `Iterable`.
* If the number of elements is less than `n` or if `n` is not greater than zero,
* an empty array is returned.
*
* @example
* ```ts
* import * as assert from "node:assert"
* import { Array } from "effect"
*
* const numbers = [1, 2, 3, 4, 5]
* assert.deepStrictEqual(Array.window(numbers, 3), [[1, 2, 3], [2, 3, 4], [3, 4, 5]])
* assert.deepStrictEqual(Array.window(numbers, 6), [])
* ```
*
* @category splitting
* @since 3.13.2
*/
<A>(self: Iterable<A>, n: number): Array<Array<A>>
} = dual(2, <A>(self: Iterable<A>, n: number): Array<Array<A>> => {
const input = fromIterable(self)
if (n > 0 && isNonEmptyReadonlyArray(input)) {
return Array.from(
{ length: input.length - (n - 1) },
(_, index) => input.slice(index, index + n)
)
}
return []
})
/**
* Group equal, consecutive elements of a `NonEmptyReadonlyArray` into `NonEmptyArray`s using the provided `isEquivalent` function.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.groupWith(["a", "a", "b", "b", "b", "c", "a"], (x, y) => x === y)
* console.log(result) // [["a", "a"], ["b", "b", "b"], ["c"], ["a"]]
* ```
*
* @category grouping
* @since 2.0.0
*/
export const groupWith: {
/**
* Group equal, consecutive elements of a `NonEmptyReadonlyArray` into `NonEmptyArray`s using the provided `isEquivalent` function.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.groupWith(["a", "a", "b", "b", "b", "c", "a"], (x, y) => x === y)
* console.log(result) // [["a", "a"], ["b", "b", "b"], ["c"], ["a"]]
* ```
*
* @category grouping
* @since 2.0.0
*/
<A>(isEquivalent: (self: A, that: A) => boolean): (self: NonEmptyReadonlyArray<A>) => NonEmptyArray<NonEmptyArray<A>>
/**
* Group equal, consecutive elements of a `NonEmptyReadonlyArray` into `NonEmptyArray`s using the provided `isEquivalent` function.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.groupWith(["a", "a", "b", "b", "b", "c", "a"], (x, y) => x === y)
* console.log(result) // [["a", "a"], ["b", "b", "b"], ["c"], ["a"]]
* ```
*
* @category grouping
* @since 2.0.0
*/
<A>(
self: NonEmptyReadonlyArray<A>,
isEquivalent: (self: A, that: A) => boolean
): NonEmptyArray<NonEmptyArray<A>>
} = dual(
2,
<A>(self: NonEmptyReadonlyArray<A>, isEquivalent: (self: A, that: A) => boolean): NonEmptyArray<NonEmptyArray<A>> =>
chop(self, (as) => {
const h = headNonEmpty(as)
const out: NonEmptyArray<A> = [h]
let i = 1
for (; i < as.length; i++) {
const a = as[i]
if (isEquivalent(a, h)) {
out.push(a)
} else {
break
}
}
return [out, as.slice(i)]
})
)
/**
* Group equal, consecutive elements of a `NonEmptyReadonlyArray` into `NonEmptyArray`s.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.group([1, 1, 2, 2, 2, 3, 1])
* console.log(result) // [[1, 1], [2, 2, 2], [3], [1]]
* ```
*
* @category grouping
* @since 2.0.0
*/
export const group: <A>(self: NonEmptyReadonlyArray<A>) => NonEmptyArray<NonEmptyArray<A>> = groupWith(
Equal.equivalence()
)
/**
* Splits an `Iterable` 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**
*
* ```ts
* import { Array } from "effect"
*
* const people = [
* { name: "Alice", group: "A" },
* { name: "Bob", group: "B" },
* { name: "Charlie", group: "A" }
* ]
*
* const result = Array.groupBy(people, person => person.group)
* console.log(result)
* // {
* // A: [{ name: "Alice", group: "A" }, { name: "Charlie", group: "A" }],
* // B: [{ name: "Bob", group: "B" }]
* // }
* ```
*
* @category grouping
* @since 2.0.0
*/
export const groupBy: {
/**
* Splits an `Iterable` 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**
*
* ```ts
* import { Array } from "effect"
*
* const people = [
* { name: "Alice", group: "A" },
* { name: "Bob", group: "B" },
* { name: "Charlie", group: "A" }
* ]
*
* const result = Array.groupBy(people, person => person.group)
* console.log(result)
* // {
* // A: [{ name: "Alice", group: "A" }, { name: "Charlie", group: "A" }],
* // B: [{ name: "Bob", group: "B" }]
* // }
* ```
*
* @category grouping
* @since 2.0.0
*/
<A, K extends string | symbol>(f: (a: A) => K): (self: Iterable<A>) => Record<Record.ReadonlyRecord.NonLiteralKey<K>, NonEmptyArray<A>>
/**
* Splits an `Iterable` 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**
*
* ```ts
* import { Array } from "effect"
*
* const people = [
* { name: "Alice", group: "A" },
* { name: "Bob", group: "B" },
* { name: "Charlie", group: "A" }
* ]
*
* const result = Array.groupBy(people, person => person.group)
* console.log(result)
* // {
* // A: [{ name: "Alice", group: "A" }, { name: "Charlie", group: "A" }],
* // B: [{ name: "Bob", group: "B" }]
* // }
* ```
*
* @category grouping
* @since 2.0.0
*/
<A, K extends string | symbol>(self: Iterable<A>, f: (a: A) => K): Record<Record.ReadonlyRecord.NonLiteralKey<K>, NonEmptyArray<A>>
} = dual(2, <A, K extends string | symbol>(
self: Iterable<A>,
f: (a: A) => K
): Record<Record.ReadonlyRecord.NonLiteralKey<K>, NonEmptyArray<A>> => {
const out: Record<string | symbol, NonEmptyArray<A>> = {}
for (const a of self) {
const k = f(a)
if (Object.prototype.hasOwnProperty.call(out, k)) {
out[k].push(a)
} else {
out[k] = [a]
}
}
return out
})
/**
* Calculates the union of two arrays using the provided equivalence relation.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const union = Array.unionWith([1, 2], [2, 3], (a, b) => a === b)
* console.log(union) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
export const unionWith: {
/**
* Calculates the union of two arrays using the provided equivalence relation.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const union = Array.unionWith([1, 2], [2, 3], (a, b) => a === b)
* console.log(union) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<S extends Iterable<any>, T extends Iterable<any>>(
that: T,
isEquivalent: (self: ReadonlyArray.Infer<S>, that: ReadonlyArray.Infer<T>) => boolean
): (self: S) => ReadonlyArray.OrNonEmpty<S, T, ReadonlyArray.Infer<S> | ReadonlyArray.Infer<T>>
/**
* Calculates the union of two arrays using the provided equivalence relation.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const union = Array.unionWith([1, 2], [2, 3], (a, b) => a === b)
* console.log(union) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(
self: NonEmptyReadonlyArray<A>,
that: Iterable<B>,
isEquivalent: (self: A, that: B) => boolean
): NonEmptyArray<A | B>
/**
* Calculates the union of two arrays using the provided equivalence relation.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const union = Array.unionWith([1, 2], [2, 3], (a, b) => a === b)
* console.log(union) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(
self: Iterable<A>,
that: NonEmptyReadonlyArray<B>,
isEquivalent: (self: A, that: B) => boolean
): NonEmptyArray<A | B>
/**
* Calculates the union of two arrays using the provided equivalence relation.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const union = Array.unionWith([1, 2], [2, 3], (a, b) => a === b)
* console.log(union) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(
self: Iterable<A>,
that: Iterable<B>,
isEquivalent: (self: A, that: B) => boolean
): Array<A | B>
} = dual(3, <A>(self: Iterable<A>, that: Iterable<A>, isEquivalent: (self: A, that: A) => boolean): Array<A> => {
const a = fromIterable(self)
const b = fromIterable(that)
if (isNonEmptyReadonlyArray(a)) {
if (isNonEmptyReadonlyArray(b)) {
const dedupe = dedupeWith(isEquivalent)
return dedupe(appendAll(a, b))
}
return a
}
return b
})
/**
* Creates a union of two arrays, removing duplicates.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.union([1, 2], [2, 3])
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
export const union: {
/**
* Creates a union of two arrays, removing duplicates.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.union([1, 2], [2, 3])
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<T extends Iterable<any>>(that: T): <S extends Iterable<any>>(
self: S
) => ReadonlyArray.OrNonEmpty<S, T, ReadonlyArray.Infer<S> | ReadonlyArray.Infer<T>>
/**
* Creates a union of two arrays, removing duplicates.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.union([1, 2], [2, 3])
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(self: NonEmptyReadonlyArray<A>, that: ReadonlyArray<B>): NonEmptyArray<A | B>
/**
* Creates a union of two arrays, removing duplicates.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.union([1, 2], [2, 3])
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(self: ReadonlyArray<A>, that: NonEmptyReadonlyArray<B>): NonEmptyArray<A | B>
/**
* Creates a union of two arrays, removing duplicates.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.union([1, 2], [2, 3])
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, that: Iterable<B>): Array<A | B>
} = dual(2, <A, B>(self: Iterable<A>, that: Iterable<B>): Array<A | B> => unionWith(self, that, _equivalence))
/**
* Creates an `Array` of unique values that are included in all given `Iterable`s using the provided `isEquivalent` function.
* The order and references of result values are determined by the first `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const array1 = [{ id: 1 }, { id: 2 }, { id: 3 }]
* const array2 = [{ id: 3 }, { id: 4 }, { id: 1 }]
* const isEquivalent = (a: { id: number }, b: { id: number }) => a.id === b.id
* const result = Array.intersectionWith(isEquivalent)(array2)(array1)
* console.log(result) // [{ id: 1 }, { id: 3 }]
* ```
*
* @since 2.0.0
*/
export const intersectionWith = <A>(isEquivalent: (self: A, that: A) => boolean): {
(that: Iterable<A>): (self: Iterable<A>) => Array<A>
(self: Iterable<A>, that: Iterable<A>): Array<A>
} => {
const has = containsWith(isEquivalent)
return dual(
2,
(self: Iterable<A>, that: Iterable<A>): Array<A> => fromIterable(self).filter((a) => has(that, a))
)
}
/**
* Creates an `Array` of unique values that are included in all given `Iterable`s.
* The order and references of result values are determined by the first `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.intersection([1, 2, 3], [3, 4, 1])
* console.log(result) // [1, 3]
* ```
*
* @since 2.0.0
*/
export const intersection: {
/**
* Creates an `Array` of unique values that are included in all given `Iterable`s.
* The order and references of result values are determined by the first `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.intersection([1, 2, 3], [3, 4, 1])
* console.log(result) // [1, 3]
* ```
*
* @since 2.0.0
*/
<B>(that: Iterable<B>): <A>(self: Iterable<A>) => Array<A & B>
/**
* Creates an `Array` of unique values that are included in all given `Iterable`s.
* The order and references of result values are determined by the first `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.intersection([1, 2, 3], [3, 4, 1])
* console.log(result) // [1, 3]
* ```
*
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, that: Iterable<B>): Array<A & B>
} = intersectionWith(_equivalence)
/**
* Creates a `Array` of values not included in the other given `Iterable` using the provided `isEquivalent` function.
* The order and references of result values are determined by the first `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const array1 = [1, 2, 3]
* const array2 = [2, 3, 4]
* const difference = Array.differenceWith<number>((a, b) => a === b)(array1, array2)
* console.log(difference) // [1]
* ```
*
* @since 2.0.0
*/
export const differenceWith = <A>(isEquivalent: (self: A, that: A) => boolean): {
(that: Iterable<A>): (self: Iterable<A>) => Array<A>
(self: Iterable<A>, that: Iterable<A>): Array<A>
} => {
const has = containsWith(isEquivalent)
return dual(
2,
(self: Iterable<A>, that: Iterable<A>): Array<A> => fromIterable(self).filter((a) => !has(that, a))
)
}
/**
* Creates a `Array` of values not included in the other given `Iterable`.
* The order and references of result values are determined by the first `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const difference = Array.difference([1, 2, 3], [2, 3, 4])
* console.log(difference) // [1]
* ```
*
* @since 2.0.0
*/
export const difference: {
/**
* Creates a `Array` of values not included in the other given `Iterable`.
* The order and references of result values are determined by the first `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const difference = Array.difference([1, 2, 3], [2, 3, 4])
* console.log(difference) // [1]
* ```
*
* @since 2.0.0
*/
<A>(that: Iterable<A>): (self: Iterable<A>) => Array<A>
/**
* Creates a `Array` of values not included in the other given `Iterable`.
* The order and references of result values are determined by the first `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const difference = Array.difference([1, 2, 3], [2, 3, 4])
* console.log(difference) // [1]
* ```
*
* @since 2.0.0
*/
<A>(self: Iterable<A>, that: Iterable<A>): Array<A>
} = differenceWith(_equivalence)
/**
* @category constructors
* @since 2.0.0
*/
export const empty: <A = never>() => Array<A> = () => []
/**
* Constructs a new `NonEmptyArray<A>` from the specified value.
*
* @category constructors
* @since 2.0.0
*/
export const of = <A>(a: A): NonEmptyArray<A> => [a]
/**
* @since 2.0.0
*/
export declare namespace ReadonlyArray {
/**
* @since 2.0.0
*/
export type Infer<S extends Iterable<any>> = S extends ReadonlyArray<infer A> ? A
: S extends Iterable<infer A> ? A
: never
/**
* @since 2.0.0
*/
export type With<S extends Iterable<any>, A> = S extends NonEmptyReadonlyArray<any> ? NonEmptyArray<A>
: Array<A>
/**
* @since 2.0.0
*/
export type OrNonEmpty<
S extends Iterable<any>,
T extends Iterable<any>,
A
> = S extends NonEmptyReadonlyArray<any> ? NonEmptyArray<A>
: T extends NonEmptyReadonlyArray<any> ? NonEmptyArray<A>
: Array<A>
/**
* @since 2.0.0
*/
export type AndNonEmpty<
S extends Iterable<any>,
T extends Iterable<any>,
A
> = S extends NonEmptyReadonlyArray<any> ? T extends NonEmptyReadonlyArray<any> ? NonEmptyArray<A>
: Array<A>
: Array<A>
/**
* @since 2.0.0
*/
export type Flatten<T extends ReadonlyArray<ReadonlyArray<any>>> = T extends
NonEmptyReadonlyArray<NonEmptyReadonlyArray<infer A>> ? NonEmptyArray<A>
: T extends ReadonlyArray<ReadonlyArray<infer A>> ? Array<A>
: never
}
/**
* @category mapping
* @since 2.0.0
*/
export const map: {
/**
* @category mapping
* @since 2.0.0
*/
<S extends ReadonlyArray<any>, B>(f: (a: ReadonlyArray.Infer<S>, i: number) => B): (self: S) => ReadonlyArray.With<S, B>
/**
* @category mapping
* @since 2.0.0
*/
<S extends ReadonlyArray<any>, B>(self: S, f: (a: ReadonlyArray.Infer<S>, i: number) => B): ReadonlyArray.With<S, B>
} = dual(2, <A, B>(self: ReadonlyArray<A>, f: (a: A, i: number) => B): Array<B> => self.map(f))
/**
* Applies a function to each element in an array and returns a new array containing the concatenated mapped elements.
*
* @category sequencing
* @since 2.0.0
*/
export const flatMap: {
/**
* Applies a function to each element in an array and returns a new array containing the concatenated mapped elements.
*
* @category sequencing
* @since 2.0.0
*/
<S extends ReadonlyArray<any>, T extends ReadonlyArray<any>>(f: (a: ReadonlyArray.Infer<S>, i: number) => T): (self: S) => ReadonlyArray.AndNonEmpty<S, T, ReadonlyArray.Infer<T>>
/**
* Applies a function to each element in an array and returns a new array containing the concatenated mapped elements.
*
* @category sequencing
* @since 2.0.0
*/
<A, B>(
self: NonEmptyReadonlyArray<A>,
f: (a: A, i: number) => NonEmptyReadonlyArray<B>
): NonEmptyArray<B>
/**
* Applies a function to each element in an array and returns a new array containing the concatenated mapped elements.
*
* @category sequencing
* @since 2.0.0
*/
<A, B>(self: ReadonlyArray<A>, f: (a: A, i: number) => ReadonlyArray<B>): Array<B>
} = dual(
2,
<A, B>(self: ReadonlyArray<A>, f: (a: A, i: number) => ReadonlyArray<B>): Array<B> => {
if (isEmptyReadonlyArray(self)) {
return []
}
const out: Array<B> = []
for (let i = 0; i < self.length; i++) {
const inner = f(self[i], i)
for (let j = 0; j < inner.length; j++) {
out.push(inner[j])
}
}
return out
}
)
/**
* Combines multiple arrays into a single array by concatenating all elements
* from each nested array. This function ensures that the structure of nested
* arrays is collapsed into a single, flat array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.flatten([[1, 2], [], [3, 4], [], [5, 6]])
* console.log(result) // [1, 2, 3, 4, 5, 6]
* ```
*
* @category sequencing
* @since 2.0.0
*/
export const flatten: <S extends ReadonlyArray<ReadonlyArray<any>>>(self: S) => ReadonlyArray.Flatten<S> = flatMap(
identity
) as any
/**
* Applies a function to each element of the `Iterable` and filters based on the result, keeping the transformed values where the function returns `Some`.
* This method combines filtering and mapping functionalities, allowing transformations and filtering of elements based on a single function pass.
*
* **Example**
*
* ```ts
* import { Array, Option } from "effect"
*
* const evenSquares = (x: number) => x % 2 === 0 ? Option.some(x * x) : Option.none()
*
* const result = Array.filterMap([1, 2, 3, 4, 5], evenSquares);
* console.log(result) // [4, 16]
* ```
*
* @category filtering
* @since 2.0.0
*/
export const filterMap: {
/**
* Applies a function to each element of the `Iterable` and filters based on the result, keeping the transformed values where the function returns `Some`.
* This method combines filtering and mapping functionalities, allowing transformations and filtering of elements based on a single function pass.
*
* **Example**
*
* ```ts
* import { Array, Option } from "effect"
*
* const evenSquares = (x: number) => x % 2 === 0 ? Option.some(x * x) : Option.none()
*
* const result = Array.filterMap([1, 2, 3, 4, 5], evenSquares);
* console.log(result) // [4, 16]
* ```
*
* @category filtering
* @since 2.0.0
*/
<A, B>(f: (a: A, i: number) => Option.Option<B>): (self: Iterable<A>) => Array<B>
/**
* Applies a function to each element of the `Iterable` and filters based on the result, keeping the transformed values where the function returns `Some`.
* This method combines filtering and mapping functionalities, allowing transformations and filtering of elements based on a single function pass.
*
* **Example**
*
* ```ts
* import { Array, Option } from "effect"
*
* const evenSquares = (x: number) => x % 2 === 0 ? Option.some(x * x) : Option.none()
*
* const result = Array.filterMap([1, 2, 3, 4, 5], evenSquares);
* console.log(result) // [4, 16]
* ```
*
* @category filtering
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, f: (a: A, i: number) => Option.Option<B>): Array<B>
} = dual(
2,
<A, B>(self: Iterable<A>, f: (a: A, i: number) => Option.Option<B>): Array<B> => {
const as = fromIterable(self)
const out: Array<B> = []
for (let i = 0; i < as.length; i++) {
const o = f(as[i], i)
if (Option.isSome(o)) {
out.push(o.value)
}
}
return out
}
)
/**
* Applies a function to each element of the array and filters based on the result, stopping when a condition is not met.
* This method combines filtering and mapping in a single pass, and short-circuits, i.e., stops processing, as soon as the function returns `None`.
* This is useful when you need to transform an array but only up to the point where a certain condition holds true.
*
* **Example**
*
* ```ts
* import { Array, Option } from "effect"
*
* const toSquareTillOdd = (x: number) => x % 2 === 0 ? Option.some(x * x) : Option.none()
*
* const result = Array.filterMapWhile([2, 4, 5], toSquareTillOdd)
* console.log(result) // [4, 16]
* ```
*
* @category filtering
* @since 2.0.0
*/
export const filterMapWhile: {
/**
* Applies a function to each element of the array and filters based on the result, stopping when a condition is not met.
* This method combines filtering and mapping in a single pass, and short-circuits, i.e., stops processing, as soon as the function returns `None`.
* This is useful when you need to transform an array but only up to the point where a certain condition holds true.
*
* **Example**
*
* ```ts
* import { Array, Option } from "effect"
*
* const toSquareTillOdd = (x: number) => x % 2 === 0 ? Option.some(x * x) : Option.none()
*
* const result = Array.filterMapWhile([2, 4, 5], toSquareTillOdd)
* console.log(result) // [4, 16]
* ```
*
* @category filtering
* @since 2.0.0
*/
<A, B>(f: (a: A, i: number) => Option.Option<B>): (self: Iterable<A>) => Array<B>
/**
* Applies a function to each element of the array and filters based on the result, stopping when a condition is not met.
* This method combines filtering and mapping in a single pass, and short-circuits, i.e., stops processing, as soon as the function returns `None`.
* This is useful when you need to transform an array but only up to the point where a certain condition holds true.
*
* **Example**
*
* ```ts
* import { Array, Option } from "effect"
*
* const toSquareTillOdd = (x: number) => x % 2 === 0 ? Option.some(x * x) : Option.none()
*
* const result = Array.filterMapWhile([2, 4, 5], toSquareTillOdd)
* console.log(result) // [4, 16]
* ```
*
* @category filtering
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, f: (a: A, i: number) => Option.Option<B>): Array<B>
} = dual(2, <A, B>(self: Iterable<A>, f: (a: A, i: number) => Option.Option<B>) => {
let i = 0
const out: Array<B> = []
for (const a of self) {
const b = f(a, i)
if (Option.isSome(b)) {
out.push(b.value)
} else {
break
}
i++
}
return out
})
/**
* Applies a function to each element of the `Iterable`, categorizing the results into two separate arrays.
* This function is particularly useful for operations where each element can result in two possible types,
* and you want to separate these types into different collections. For instance, separating validation results
* into successes and failures.
*
* **Example**
*
* ```ts
* import { Array, Either } from "effect";
*
* const isEven = (x: number) => x % 2 === 0
*
* const result = Array.partitionMap([1, 2, 3, 4, 5], x =>
* isEven(x) ? Either.right(x) : Either.left(x)
* )
* console.log(result)
* // [
* // [1, 3, 5],
* // [2, 4]
* // ]
* ```
*
* @category filtering
* @since 2.0.0
*/
export const partitionMap: {
/**
* Applies a function to each element of the `Iterable`, categorizing the results into two separate arrays.
* This function is particularly useful for operations where each element can result in two possible types,
* and you want to separate these types into different collections. For instance, separating validation results
* into successes and failures.
*
* **Example**
*
* ```ts
* import { Array, Either } from "effect";
*
* const isEven = (x: number) => x % 2 === 0
*
* const result = Array.partitionMap([1, 2, 3, 4, 5], x =>
* isEven(x) ? Either.right(x) : Either.left(x)
* )
* console.log(result)
* // [
* // [1, 3, 5],
* // [2, 4]
* // ]
* ```
*
* @category filtering
* @since 2.0.0
*/
<A, B, C>(f: (a: A, i: number) => Either.Either<C, B>): (self: Iterable<A>) => [left: Array<B>, right: Array<C>]
/**
* Applies a function to each element of the `Iterable`, categorizing the results into two separate arrays.
* This function is particularly useful for operations where each element can result in two possible types,
* and you want to separate these types into different collections. For instance, separating validation results
* into successes and failures.
*
* **Example**
*
* ```ts
* import { Array, Either } from "effect";
*
* const isEven = (x: number) => x % 2 === 0
*
* const result = Array.partitionMap([1, 2, 3, 4, 5], x =>
* isEven(x) ? Either.right(x) : Either.left(x)
* )
* console.log(result)
* // [
* // [1, 3, 5],
* // [2, 4]
* // ]
* ```
*
* @category filtering
* @since 2.0.0
*/
<A, B, C>(self: Iterable<A>, f: (a: A, i: number) => Either.Either<C, B>): [left: Array<B>, right: Array<C>]
} = dual(
2,
<A, B, C>(self: Iterable<A>, f: (a: A, i: number) => Either.Either<C, B>): [left: Array<B>, right: Array<C>] => {
const left: Array<B> = []
const right: Array<C> = []
const as = fromIterable(self)
for (let i = 0; i < as.length; i++) {
const e = f(as[i], i)
if (Either.isLeft(e)) {
left.push(e.left)
} else {
right.push(e.right)
}
}
return [left, right]
}
)
/**
* Retrieves the `Some` values from an `Iterable` of `Option`s, collecting them into an array.
*
* **Example**
*
* ```ts
* import { Array, Option } from "effect"
*
* const result = Array.getSomes([Option.some(1), Option.none(), Option.some(2)])
* console.log(result) // [1, 2]
* ```
*
* @category filtering
* @since 2.0.0
*/
export const getSomes: <T extends Iterable<Option.Option<X>>, X = any>(
self: T
) => Array<Option.Option.Value<ReadonlyArray.Infer<T>>> = filterMap(identity as any)
/**
* Retrieves the `Left` values from an `Iterable` of `Either`s, collecting them into an array.
*
* **Example**
*
* ```ts
* import { Array, Either } from "effect"
*
* const result = Array.getLefts([Either.right(1), Either.left("err"), Either.right(2)])
* console.log(result) // ["err"]
* ```
*
* @category filtering
* @since 2.0.0
*/
export const getLefts = <T extends Iterable<Either.Either<any, any>>>(
self: T
): Array<Either.Either.Left<ReadonlyArray.Infer<T>>> => {
const out: Array<any> = []
for (const a of self) {
if (Either.isLeft(a)) {
out.push(a.left)
}
}
return out
}
/**
* Retrieves the `Right` values from an `Iterable` of `Either`s, collecting them into an array.
*
* **Example**
*
* ```ts
* import { Array, Either } from "effect"
*
* const result = Array.getRights([Either.right(1), Either.left("err"), Either.right(2)])
* console.log(result) // [1, 2]
* ```
*
* @category filtering
* @since 2.0.0
*/
export const getRights = <T extends Iterable<Either.Either<any, any>>>(
self: T
): Array<Either.Either.Right<ReadonlyArray.Infer<T>>> => {
const out: Array<any> = []
for (const a of self) {
if (Either.isRight(a)) {
out.push(a.right)
}
}
return out
}
/**
* @category filtering
* @since 2.0.0
*/
export const filter: {
/**
* @category filtering
* @since 2.0.0
*/
<A, B extends A>(refinement: (a: NoInfer<A>, i: number) => a is B): (self: Iterable<A>) => Array<B>
/**
* @category filtering
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => Array<A>
/**
* @category filtering
* @since 2.0.0
*/
<A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): Array<B>
/**
* @category filtering
* @since 2.0.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A>
} = dual(
2,
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): Array<A> => {
const as = fromIterable(self)
const out: Array<A> = []
for (let i = 0; i < as.length; i++) {
if (predicate(as[i], i)) {
out.push(as[i])
}
}
return out
}
)
/**
* Separate elements based on a predicate that also exposes the index of the element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.partition([1, 2, 3, 4], n => n % 2 === 0)
* console.log(result) // [[1, 3], [2, 4]]
* ```
*
* @category filtering
* @since 2.0.0
*/
export const partition: {
/**
* Separate elements based on a predicate that also exposes the index of the element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.partition([1, 2, 3, 4], n => n % 2 === 0)
* console.log(result) // [[1, 3], [2, 4]]
* ```
*
* @category filtering
* @since 2.0.0
*/
<A, B extends A>(refinement: (a: NoInfer<A>, i: number) => a is B): (
self: Iterable<A>
) => [excluded: Array<Exclude<A, B>>, satisfying: Array<B>]
/**
* Separate elements based on a predicate that also exposes the index of the element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.partition([1, 2, 3, 4], n => n % 2 === 0)
* console.log(result) // [[1, 3], [2, 4]]
* ```
*
* @category filtering
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: Iterable<A>) => [excluded: Array<A>, satisfying: Array<A>]
/**
* Separate elements based on a predicate that also exposes the index of the element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.partition([1, 2, 3, 4], n => n % 2 === 0)
* console.log(result) // [[1, 3], [2, 4]]
* ```
*
* @category filtering
* @since 2.0.0
*/
<A, B extends A>(self: Iterable<A>, refinement: (a: A, i: number) => a is B): [excluded: Array<Exclude<A, B>>, satisfying: Array<B>]
/**
* Separate elements based on a predicate that also exposes the index of the element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.partition([1, 2, 3, 4], n => n % 2 === 0)
* console.log(result) // [[1, 3], [2, 4]]
* ```
*
* @category filtering
* @since 2.0.0
*/
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): [excluded: Array<A>, satisfying: Array<A>]
} = dual(
2,
<A>(self: Iterable<A>, predicate: (a: A, i: number) => boolean): [excluded: Array<A>, satisfying: Array<A>] => {
const left: Array<A> = []
const right: Array<A> = []
const as = fromIterable(self)
for (let i = 0; i < as.length; i++) {
if (predicate(as[i], i)) {
right.push(as[i])
} else {
left.push(as[i])
}
}
return [left, right]
}
)
/**
* Separates an `Iterable` into two arrays based on a predicate.
*
* @category filtering
* @since 2.0.0
*/
export const separate: <T extends Iterable<Either.Either<any, any>>>(
self: T
) => [Array<Either.Either.Left<ReadonlyArray.Infer<T>>>, Array<Either.Either.Right<ReadonlyArray.Infer<T>>>] =
partitionMap(identity)
/**
* Reduces an array from the left.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.reduce([1, 2, 3], 0, (acc, n) => acc + n)
* console.log(result) // 6
* ```
*
* @category folding
* @since 2.0.0
*/
export const reduce: {
/**
* Reduces an array from the left.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.reduce([1, 2, 3], 0, (acc, n) => acc + n)
* console.log(result) // 6
* ```
*
* @category folding
* @since 2.0.0
*/
<B, A>(b: B, f: (b: B, a: A, i: number) => B): (self: Iterable<A>) => B
/**
* Reduces an array from the left.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.reduce([1, 2, 3], 0, (acc, n) => acc + n)
* console.log(result) // 6
* ```
*
* @category folding
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, b: B, f: (b: B, a: A, i: number) => B): B
} = dual(
3,
<B, A>(self: Iterable<A>, b: B, f: (b: B, a: A, i: number) => B): B =>
fromIterable(self).reduce((b, a, i) => f(b, a, i), b)
)
/**
* Reduces an array from the right.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.reduceRight([1, 2, 3], 0, (acc, n) => acc + n)
* console.log(result) // 6
* ```
*
* @category folding
* @since 2.0.0
*/
export const reduceRight: {
/**
* Reduces an array from the right.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.reduceRight([1, 2, 3], 0, (acc, n) => acc + n)
* console.log(result) // 6
* ```
*
* @category folding
* @since 2.0.0
*/
<B, A>(b: B, f: (b: B, a: A, i: number) => B): (self: Iterable<A>) => B
/**
* Reduces an array from the right.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.reduceRight([1, 2, 3], 0, (acc, n) => acc + n)
* console.log(result) // 6
* ```
*
* @category folding
* @since 2.0.0
*/
<A, B>(self: Iterable<A>, b: B, f: (b: B, a: A, i: number) => B): B
} = dual(
3,
<A, B>(self: Iterable<A>, b: B, f: (b: B, a: A, i: number) => B): B =>
fromIterable(self).reduceRight((b, a, i) => f(b, a, i), b)
)
/**
* Lifts a predicate into an array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const isEven = (n: number) => n % 2 === 0
* const to = Array.liftPredicate(isEven)
* console.log(to(1)) // []
* console.log(to(2)) // [2]
* ```
*
* @category lifting
* @since 2.0.0
*/
export const liftPredicate: { // Note: I intentionally avoid using the NoInfer pattern here.
<A, B extends A>(refinement: Predicate.Refinement<A, B>): (a: A) => Array<B>
/**
* Lifts a predicate into an array.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const isEven = (n: number) => n % 2 === 0
* const to = Array.liftPredicate(isEven)
* console.log(to(1)) // []
* console.log(to(2)) // [2]
* ```
*
* @category lifting
* @since 2.0.0
*/
<A>(predicate: Predicate.Predicate<A>): <B extends A>(b: B) => Array<B>
} = <A>(predicate: Predicate.Predicate<A>) => <B extends A>(b: B): Array<B> => predicate(b) ? [b] : []
/**
* @category lifting
* @since 2.0.0
*/
export const liftOption = <A extends Array<unknown>, B>(
f: (...a: A) => Option.Option<B>
) =>
(...a: A): Array<B> => fromOption(f(...a))
/**
* @category conversions
* @since 2.0.0
*/
export const fromNullable = <A>(a: A): Array<NonNullable<A>> => a == null ? empty() : [a as NonNullable<A>]
/**
* @category lifting
* @since 2.0.0
*/
export const liftNullable = <A extends Array<unknown>, B>(
f: (...a: A) => B | null | undefined
): (...a: A) => Array<NonNullable<B>> =>
(...a) => fromNullable(f(...a))
/**
* Maps over an array and flattens the result, removing null and undefined values.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.flatMapNullable([1, 2, 3], n => (n % 2 === 0 ? null : n))
* console.log(result) // [1, 3]
*
* // Explanation:
* // The array of numbers [1, 2, 3] is mapped with a function that returns null for even numbers
* // and the number itself for odd numbers. The resulting array [1, null, 3] is then flattened
* // to remove null values, resulting in [1, 3].
* ```
*
* @category sequencing
* @since 2.0.0
*/
export const flatMapNullable: {
/**
* Maps over an array and flattens the result, removing null and undefined values.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.flatMapNullable([1, 2, 3], n => (n % 2 === 0 ? null : n))
* console.log(result) // [1, 3]
*
* // Explanation:
* // The array of numbers [1, 2, 3] is mapped with a function that returns null for even numbers
* // and the number itself for odd numbers. The resulting array [1, null, 3] is then flattened
* // to remove null values, resulting in [1, 3].
* ```
*
* @category sequencing
* @since 2.0.0
*/
<A, B>(f: (a: A) => B | null | undefined): (self: ReadonlyArray<A>) => Array<NonNullable<B>>
/**
* Maps over an array and flattens the result, removing null and undefined values.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.flatMapNullable([1, 2, 3], n => (n % 2 === 0 ? null : n))
* console.log(result) // [1, 3]
*
* // Explanation:
* // The array of numbers [1, 2, 3] is mapped with a function that returns null for even numbers
* // and the number itself for odd numbers. The resulting array [1, null, 3] is then flattened
* // to remove null values, resulting in [1, 3].
* ```
*
* @category sequencing
* @since 2.0.0
*/
<A, B>(self: ReadonlyArray<A>, f: (a: A) => B | null | undefined): Array<NonNullable<B>>
} = dual(
2,
<A, B>(self: ReadonlyArray<A>, f: (a: A) => B | null | undefined): Array<NonNullable<B>> =>
flatMap(self, (a) => fromNullable(f(a)))
)
/**
* Lifts a function that returns an `Either` into a function that returns an array.
* If the `Either` is a left, it returns an empty array.
* If the `Either` is a right, it returns an array with the right value.
*
* **Example**
*
* ```ts
* import { Array, Either } from "effect"
*
* const parseNumber = (s: string): Either.Either<number, Error> =>
* isNaN(Number(s)) ? Either.left(new Error("Not a number")) : Either.right(Number(s))
*
* const liftedParseNumber = Array.liftEither(parseNumber)
*
* const result1 = liftedParseNumber("42")
* console.log(result1) // [42]
*
* const result2 = liftedParseNumber("not a number")
* console.log(result2) // []
*
* // Explanation:
* // The function parseNumber is lifted to return an array.
* // When parsing "42", it returns an Either.left with the number 42, resulting in [42].
* // When parsing "not a number", it returns an Either.right with an error, resulting in an empty array [].
* ```
*
* @category lifting
* @since 2.0.0
*/
export const liftEither = <A extends Array<unknown>, E, B>(
f: (...a: A) => Either.Either<B, E>
) =>
(...a: A): Array<B> => {
const e = f(...a)
return Either.isLeft(e) ? [] : [e.right]
}
/**
* Check if a predicate holds true for every `ReadonlyArray` element.
*
* @category elements
* @since 2.0.0
*/
export const every: {
/**
* Check if a predicate holds true for every `ReadonlyArray` element.
*
* @category elements
* @since 2.0.0
*/
<A, B extends A>(refinement: (a: NoInfer<A>, i: number) => a is B): (self: ReadonlyArray<A>) => self is ReadonlyArray<B>
/**
* Check if a predicate holds true for every `ReadonlyArray` element.
*
* @category elements
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: ReadonlyArray<A>) => boolean
/**
* Check if a predicate holds true for every `ReadonlyArray` element.
*
* @category elements
* @since 2.0.0
*/
<A, B extends A>(self: ReadonlyArray<A>, refinement: (a: A, i: number) => a is B): self is ReadonlyArray<B>
/**
* Check if a predicate holds true for every `ReadonlyArray` element.
*
* @category elements
* @since 2.0.0
*/
<A>(self: ReadonlyArray<A>, predicate: (a: A, i: number) => boolean): boolean
} = dual(
2,
<A, B extends A>(self: ReadonlyArray<A>, refinement: (a: A, i: number) => a is B): self is ReadonlyArray<B> =>
self.every(refinement)
)
/**
* Check if a predicate holds true for some `ReadonlyArray` element.
*
* @category elements
* @since 2.0.0
*/
export const some: {
/**
* Check if a predicate holds true for some `ReadonlyArray` element.
*
* @category elements
* @since 2.0.0
*/
<A>(predicate: (a: NoInfer<A>, i: number) => boolean): (self: ReadonlyArray<A>) => self is NonEmptyReadonlyArray<A>
/**
* Check if a predicate holds true for some `ReadonlyArray` element.
*
* @category elements
* @since 2.0.0
*/
<A>(self: ReadonlyArray<A>, predicate: (a: A, i: number) => boolean): self is NonEmptyReadonlyArray<A>
} = dual(
2,
<A>(self: ReadonlyArray<A>, predicate: (a: A, i: number) => boolean): self is NonEmptyReadonlyArray<A> =>
self.some(predicate)
)
/**
* Extends an array with a function that maps each subarray to a value.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.extend([1, 2, 3], as => as.length)
* console.log(result) // [3, 2, 1]
*
* // Explanation:
* // The function maps each subarray starting from each element to its length.
* // The subarrays are: [1, 2, 3], [2, 3], [3].
* // The lengths are: 3, 2, 1.
* // Therefore, the result is [3, 2, 1].
* ```
*
* @since 2.0.0
*/
export const extend: {
/**
* Extends an array with a function that maps each subarray to a value.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.extend([1, 2, 3], as => as.length)
* console.log(result) // [3, 2, 1]
*
* // Explanation:
* // The function maps each subarray starting from each element to its length.
* // The subarrays are: [1, 2, 3], [2, 3], [3].
* // The lengths are: 3, 2, 1.
* // Therefore, the result is [3, 2, 1].
* ```
*
* @since 2.0.0
*/
<A, B>(f: (as: ReadonlyArray<A>) => B): (self: ReadonlyArray<A>) => Array<B>
/**
* Extends an array with a function that maps each subarray to a value.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.extend([1, 2, 3], as => as.length)
* console.log(result) // [3, 2, 1]
*
* // Explanation:
* // The function maps each subarray starting from each element to its length.
* // The subarrays are: [1, 2, 3], [2, 3], [3].
* // The lengths are: 3, 2, 1.
* // Therefore, the result is [3, 2, 1].
* ```
*
* @since 2.0.0
*/
<A, B>(self: ReadonlyArray<A>, f: (as: ReadonlyArray<A>) => B): Array<B>
} = dual(
2,
<A, B>(self: ReadonlyArray<A>, f: (as: ReadonlyArray<A>) => B): Array<B> => self.map((_, i, as) => f(as.slice(i)))
)
/**
* Finds the minimum element in an array based on a comparator.
*
* **Example**
*
* ```ts
* import { Array, Order } from "effect"
*
* const result = Array.min([3, 1, 2], Order.number)
* console.log(result) // 1
* ```
*
* @since 2.0.0
*/
export const min: {
/**
* Finds the minimum element in an array based on a comparator.
*
* **Example**
*
* ```ts
* import { Array, Order } from "effect"
*
* const result = Array.min([3, 1, 2], Order.number)
* console.log(result) // 1
* ```
*
* @since 2.0.0
*/
<A>(O: Order.Order<A>): (self: NonEmptyReadonlyArray<A>) => A
/**
* Finds the minimum element in an array based on a comparator.
*
* **Example**
*
* ```ts
* import { Array, Order } from "effect"
*
* const result = Array.min([3, 1, 2], Order.number)
* console.log(result) // 1
* ```
*
* @since 2.0.0
*/
<A>(self: NonEmptyReadonlyArray<A>, O: Order.Order<A>): A
} = dual(2, <A>(self: NonEmptyReadonlyArray<A>, O: Order.Order<A>): A => self.reduce(Order.min(O)))
/**
* Finds the maximum element in an array based on a comparator.
*
* **Example**
*
* ```ts
* import { Array, Order } from "effect"
*
* const result = Array.max([3, 1, 2], Order.number)
* console.log(result) // 3
* ```
*
* @since 2.0.0
*/
export const max: {
/**
* Finds the maximum element in an array based on a comparator.
*
* **Example**
*
* ```ts
* import { Array, Order } from "effect"
*
* const result = Array.max([3, 1, 2], Order.number)
* console.log(result) // 3
* ```
*
* @since 2.0.0
*/
<A>(O: Order.Order<A>): (self: NonEmptyReadonlyArray<A>) => A
/**
* Finds the maximum element in an array based on a comparator.
*
* **Example**
*
* ```ts
* import { Array, Order } from "effect"
*
* const result = Array.max([3, 1, 2], Order.number)
* console.log(result) // 3
* ```
*
* @since 2.0.0
*/
<A>(self: NonEmptyReadonlyArray<A>, O: Order.Order<A>): A
} = dual(2, <A>(self: NonEmptyReadonlyArray<A>, O: Order.Order<A>): A => self.reduce(Order.max(O)))
/**
* @category constructors
* @since 2.0.0
*/
export const unfold = <B, A>(b: B, f: (b: B) => Option.Option<readonly [A, B]>): Array<A> => {
const out: Array<A> = []
let next: B = b
let o: Option.Option<readonly [A, B]>
while (Option.isSome(o = f(next))) {
const [a, b] = o.value
out.push(a)
next = b
}
return out
}
/**
* This function creates and returns a new `Order` for an array of values based on a given `Order` for the elements of the array.
* The returned `Order` compares two arrays by applying the given `Order` to each element in the arrays.
* If all elements are equal, the arrays are then compared based on their length.
* It is useful when you need to compare two arrays of the same type and you have a specific way of comparing each element of the array.
*
* @category instances
* @since 2.0.0
*/
export const getOrder: <A>(O: Order.Order<A>) => Order.Order<ReadonlyArray<A>> = Order.array
/**
* Creates an equivalence relation for arrays.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const eq = Array.getEquivalence<number>((a, b) => a === b)
* console.log(eq([1, 2, 3], [1, 2, 3])) // true
* ```
*
* @category instances
* @since 2.0.0
*/
export const getEquivalence: <A>(
isEquivalent: Equivalence.Equivalence<A>
) => Equivalence.Equivalence<ReadonlyArray<A>> = Equivalence.array
/**
* Performs a side-effect for each element of the `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* Array.forEach([1, 2, 3], n => console.log(n)) // 1, 2, 3
* ```
*
* @since 2.0.0
*/
export const forEach: {
/**
* Performs a side-effect for each element of the `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* Array.forEach([1, 2, 3], n => console.log(n)) // 1, 2, 3
* ```
*
* @since 2.0.0
*/
<A>(f: (a: A, i: number) => void): (self: Iterable<A>) => void
/**
* Performs a side-effect for each element of the `Iterable`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* Array.forEach([1, 2, 3], n => console.log(n)) // 1, 2, 3
* ```
*
* @since 2.0.0
*/
<A>(self: Iterable<A>, f: (a: A, i: number) => void): void
} = dual(2, <A>(self: Iterable<A>, f: (a: A, i: number) => void): void => fromIterable(self).forEach((a, i) => f(a, i)))
/**
* Remove duplicates from an `Iterable` using the provided `isEquivalent` function,
* preserving the order of the first occurrence of each element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dedupeWith([1, 2, 2, 3, 3, 3], (a, b) => a === b)
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
export const dedupeWith: {
/**
* Remove duplicates from an `Iterable` using the provided `isEquivalent` function,
* preserving the order of the first occurrence of each element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dedupeWith([1, 2, 2, 3, 3, 3], (a, b) => a === b)
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<S extends Iterable<any>>(
isEquivalent: (self: ReadonlyArray.Infer<S>, that: ReadonlyArray.Infer<S>) => boolean
): (self: S) => ReadonlyArray.With<S, ReadonlyArray.Infer<S>>
/**
* Remove duplicates from an `Iterable` using the provided `isEquivalent` function,
* preserving the order of the first occurrence of each element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dedupeWith([1, 2, 2, 3, 3, 3], (a, b) => a === b)
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A>(
self: NonEmptyReadonlyArray<A>,
isEquivalent: (self: A, that: A) => boolean
): NonEmptyArray<A>
/**
* Remove duplicates from an `Iterable` using the provided `isEquivalent` function,
* preserving the order of the first occurrence of each element.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dedupeWith([1, 2, 2, 3, 3, 3], (a, b) => a === b)
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A>(self: Iterable<A>, isEquivalent: (self: A, that: A) => boolean): Array<A>
} = dual(
2,
<A>(self: Iterable<A>, isEquivalent: (self: A, that: A) => boolean): Array<A> => {
const input = fromIterable(self)
if (isNonEmptyReadonlyArray(input)) {
const out: NonEmptyArray<A> = [headNonEmpty(input)]
const rest = tailNonEmpty(input)
for (const r of rest) {
if (out.every((a) => !isEquivalent(r, a))) {
out.push(r)
}
}
return out
}
return []
}
)
/**
* Remove duplicates from an `Iterable`, preserving the order of the first occurrence of each element.
* The equivalence used to compare elements is provided by `Equal.equivalence()` from the `Equal` module.
*
* @since 2.0.0
*/
export const dedupe = <S extends Iterable<any>>(
self: S
): S extends NonEmptyReadonlyArray<infer A> ? NonEmptyArray<A> : S extends Iterable<infer A> ? Array<A> : never =>
dedupeWith(self, Equal.equivalence()) as any
/**
* Deduplicates adjacent elements that are identical using the provided `isEquivalent` function.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dedupeAdjacentWith([1, 1, 2, 2, 3, 3], (a, b) => a === b)
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
export const dedupeAdjacentWith: {
/**
* Deduplicates adjacent elements that are identical using the provided `isEquivalent` function.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dedupeAdjacentWith([1, 1, 2, 2, 3, 3], (a, b) => a === b)
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A>(isEquivalent: (self: A, that: A) => boolean): (self: Iterable<A>) => Array<A>
/**
* Deduplicates adjacent elements that are identical using the provided `isEquivalent` function.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dedupeAdjacentWith([1, 1, 2, 2, 3, 3], (a, b) => a === b)
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
<A>(self: Iterable<A>, isEquivalent: (self: A, that: A) => boolean): Array<A>
} = dual(2, <A>(self: Iterable<A>, isEquivalent: (self: A, that: A) => boolean): Array<A> => {
const out: Array<A> = []
let lastA: Option.Option<A> = Option.none()
for (const a of self) {
if (Option.isNone(lastA) || !isEquivalent(a, lastA.value)) {
out.push(a)
lastA = Option.some(a)
}
}
return out
})
/**
* Deduplicates adjacent elements that are identical.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.dedupeAdjacent([1, 1, 2, 2, 3, 3])
* console.log(result) // [1, 2, 3]
* ```
*
* @since 2.0.0
*/
export const dedupeAdjacent: <A>(self: Iterable<A>) => Array<A> = dedupeAdjacentWith(Equal.equivalence())
/**
* Joins the elements together with "sep" in the middle.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const strings = ["a", "b", "c"]
* const joined = Array.join(strings, "-")
* console.log(joined) // "a-b-c"
* ```
*
* @since 2.0.0
* @category folding
*/
export const join: {
/**
* Joins the elements together with "sep" in the middle.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const strings = ["a", "b", "c"]
* const joined = Array.join(strings, "-")
* console.log(joined) // "a-b-c"
* ```
*
* @since 2.0.0
* @category folding
*/
(sep: string): (self: Iterable<string>) => string
/**
* Joins the elements together with "sep" in the middle.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const strings = ["a", "b", "c"]
* const joined = Array.join(strings, "-")
* console.log(joined) // "a-b-c"
* ```
*
* @since 2.0.0
* @category folding
*/
(self: Iterable<string>, sep: string): string
} = dual(2, (self: Iterable<string>, sep: string): string => fromIterable(self).join(sep))
/**
* Statefully maps over the chunk, producing new elements of type `B`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.mapAccum([1, 2, 3], 0, (acc, n) => [acc + n, acc + n])
* console.log(result) // [6, [1, 3, 6]]
* ```
*
* @since 2.0.0
* @category folding
*/
export const mapAccum: {
/**
* Statefully maps over the chunk, producing new elements of type `B`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.mapAccum([1, 2, 3], 0, (acc, n) => [acc + n, acc + n])
* console.log(result) // [6, [1, 3, 6]]
* ```
*
* @since 2.0.0
* @category folding
*/
<S, A, B, I extends Iterable<A> = Iterable<A>>(s: S, f: (s: S, a: ReadonlyArray.Infer<I>, i: number) => readonly [S, B]): (self: I) => [state: S, mappedArray: ReadonlyArray.With<I, B>]
/**
* Statefully maps over the chunk, producing new elements of type `B`.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.mapAccum([1, 2, 3], 0, (acc, n) => [acc + n, acc + n])
* console.log(result) // [6, [1, 3, 6]]
* ```
*
* @since 2.0.0
* @category folding
*/
<S, A, B, I extends Iterable<A> = Iterable<A>>(
self: I,
s: S,
f: (s: S, a: ReadonlyArray.Infer<I>, i: number) => readonly [S, B]
): [state: S, mappedArray: ReadonlyArray.With<I, B>]
} = dual(
3,
<S, A, B>(self: Iterable<A>, s: S, f: (s: S, a: A, i: number) => [S, B]): [state: S, mappedArray: Array<B>] => {
let i = 0
let s1 = s
const out: Array<B> = []
for (const a of self) {
const r = f(s1, a, i)
s1 = r[0]
out.push(r[1])
i++
}
return [s1, out]
}
)
/**
* Zips this chunk crosswise with the specified chunk using the specified combiner.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.cartesianWith([1, 2], ["a", "b"], (a, b) => `${a}-${b}`)
* console.log(result) // ["1-a", "1-b", "2-a", "2-b"]
* ```
*
* @since 2.0.0
* @category elements
*/
export const cartesianWith: {
/**
* Zips this chunk crosswise with the specified chunk using the specified combiner.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.cartesianWith([1, 2], ["a", "b"], (a, b) => `${a}-${b}`)
* console.log(result) // ["1-a", "1-b", "2-a", "2-b"]
* ```
*
* @since 2.0.0
* @category elements
*/
<A, B, C>(that: ReadonlyArray<B>, f: (a: A, b: B) => C): (self: ReadonlyArray<A>) => Array<C>
/**
* Zips this chunk crosswise with the specified chunk using the specified combiner.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.cartesianWith([1, 2], ["a", "b"], (a, b) => `${a}-${b}`)
* console.log(result) // ["1-a", "1-b", "2-a", "2-b"]
* ```
*
* @since 2.0.0
* @category elements
*/
<A, B, C>(self: ReadonlyArray<A>, that: ReadonlyArray<B>, f: (a: A, b: B) => C): Array<C>
} = dual(
3,
<A, B, C>(self: ReadonlyArray<A>, that: ReadonlyArray<B>, f: (a: A, b: B) => C): Array<C> =>
flatMap(self, (a) => map(that, (b) => f(a, b)))
)
/**
* Zips this chunk crosswise with the specified chunk.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.cartesian([1, 2], ["a", "b"])
* console.log(result) // [[1, "a"], [1, "b"], [2, "a"], [2, "b"]]
* ```
*
* @since 2.0.0
* @category elements
*/
export const cartesian: {
/**
* Zips this chunk crosswise with the specified chunk.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.cartesian([1, 2], ["a", "b"])
* console.log(result) // [[1, "a"], [1, "b"], [2, "a"], [2, "b"]]
* ```
*
* @since 2.0.0
* @category elements
*/
<B>(that: ReadonlyArray<B>): <A>(self: ReadonlyArray<A>) => Array<[A, B]>
/**
* Zips this chunk crosswise with the specified chunk.
*
* **Example**
*
* ```ts
* import { Array } from "effect"
*
* const result = Array.cartesian([1, 2], ["a", "b"])
* console.log(result) // [[1, "a"], [1, "b"], [2, "a"], [2, "b"]]
* ```
*
* @since 2.0.0
* @category elements
*/
<A, B>(self: ReadonlyArray<A>, that: ReadonlyArray<B>): Array<[A, B]>
} = dual(
2,
<A, B>(self: ReadonlyArray<A>, that: ReadonlyArray<B>): Array<[A, B]> => cartesianWith(self, that, (a, b) => [a, b])
)
// -------------------------------------------------------------------------------------
// do notation
// -------------------------------------------------------------------------------------
/**
* The "do simulation" for array allows you to sequentially apply operations to the elements of arrays, just as nested loops allow you to go through all combinations of elements in an arrays.
*
* It can be used to simulate "array comprehension".
* It's a technique that allows you to create new arrays by iterating over existing ones and applying specific **conditions** or **transformations** to the elements. It's like assembling a new collection from pieces of other collections based on certain rules.
*
* Here's how the do simulation works:
*
* 1. Start the do simulation using the `Do` value
* 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Array` values
* 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
* 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
* 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const doResult = pipe(
* Array.Do,
* Array.bind("x", () => [1, 3, 5]),
* Array.bind("y", () => [2, 4, 6]),
* Array.filter(({ x, y }) => x < y), // condition
* Array.map(({ x, y }) => [x, y] as const) // transformation
* )
* console.log(doResult) // [[1, 2], [1, 4], [1, 6], [3, 4], [3, 6], [5, 6]]
*
* // equivalent
* const x = [1, 3, 5],
* y = [2, 4, 6],
* result = [];
* for(let i = 0; i < x.length; i++) {
* for(let j = 0; j < y.length; j++) {
* const _x = x[i], _y = y[j];
* if(_x < _y) result.push([_x, _y] as const)
* }
* }
* ```
*
* @see {@link bindTo}
* @see {@link bind}
* @see {@link let_ let}
*
* @category do notation
* @since 3.2.0
*/
export const Do: ReadonlyArray<{}> = of({})
/**
* The "do simulation" for array allows you to sequentially apply operations to the elements of arrays, just as nested loops allow you to go through all combinations of elements in an arrays.
*
* It can be used to simulate "array comprehension".
* It's a technique that allows you to create new arrays by iterating over existing ones and applying specific **conditions** or **transformations** to the elements. It's like assembling a new collection from pieces of other collections based on certain rules.
*
* Here's how the do simulation works:
*
* 1. Start the do simulation using the `Do` value
* 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Array` values
* 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
* 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
* 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const doResult = pipe(
* Array.Do,
* Array.bind("x", () => [1, 3, 5]),
* Array.bind("y", () => [2, 4, 6]),
* Array.filter(({ x, y }) => x < y), // condition
* Array.map(({ x, y }) => [x, y] as const) // transformation
* )
* console.log(doResult) // [[1, 2], [1, 4], [1, 6], [3, 4], [3, 6], [5, 6]]
*
* // equivalent
* const x = [1, 3, 5],
* y = [2, 4, 6],
* result = [];
* for(let i = 0; i < x.length; i++) {
* for(let j = 0; j < y.length; j++) {
* const _x = x[i], _y = y[j];
* if(_x < _y) result.push([_x, _y] as const)
* }
* }
* ```
*
* @see {@link bindTo}
* @see {@link Do}
* @see {@link let_ let}
*
* @category do notation
* @since 3.2.0
*/
export const bind: {
/**
* The "do simulation" for array allows you to sequentially apply operations to the elements of arrays, just as nested loops allow you to go through all combinations of elements in an arrays.
*
* It can be used to simulate "array comprehension".
* It's a technique that allows you to create new arrays by iterating over existing ones and applying specific **conditions** or **transformations** to the elements. It's like assembling a new collection from pieces of other collections based on certain rules.
*
* Here's how the do simulation works:
*
* 1. Start the do simulation using the `Do` value
* 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Array` values
* 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
* 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
* 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const doResult = pipe(
* Array.Do,
* Array.bind("x", () => [1, 3, 5]),
* Array.bind("y", () => [2, 4, 6]),
* Array.filter(({ x, y }) => x < y), // condition
* Array.map(({ x, y }) => [x, y] as const) // transformation
* )
* console.log(doResult) // [[1, 2], [1, 4], [1, 6], [3, 4], [3, 6], [5, 6]]
*
* // equivalent
* const x = [1, 3, 5],
* y = [2, 4, 6],
* result = [];
* for(let i = 0; i < x.length; i++) {
* for(let j = 0; j < y.length; j++) {
* const _x = x[i], _y = y[j];
* if(_x < _y) result.push([_x, _y] as const)
* }
* }
* ```
*
* @see {@link bindTo}
* @see {@link Do}
* @see {@link let_ let}
*
* @category do notation
* @since 3.2.0
*/
<A extends object, N extends string, B>(tag: Exclude<N, keyof A>, f: (a: NoInfer<A>) => ReadonlyArray<B>): (
self: ReadonlyArray<A>
) => Array<{ [K in N | keyof A]: K extends keyof A ? A[K] : B }>
/**
* The "do simulation" for array allows you to sequentially apply operations to the elements of arrays, just as nested loops allow you to go through all combinations of elements in an arrays.
*
* It can be used to simulate "array comprehension".
* It's a technique that allows you to create new arrays by iterating over existing ones and applying specific **conditions** or **transformations** to the elements. It's like assembling a new collection from pieces of other collections based on certain rules.
*
* Here's how the do simulation works:
*
* 1. Start the do simulation using the `Do` value
* 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Array` values
* 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
* 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
* 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const doResult = pipe(
* Array.Do,
* Array.bind("x", () => [1, 3, 5]),
* Array.bind("y", () => [2, 4, 6]),
* Array.filter(({ x, y }) => x < y), // condition
* Array.map(({ x, y }) => [x, y] as const) // transformation
* )
* console.log(doResult) // [[1, 2], [1, 4], [1, 6], [3, 4], [3, 6], [5, 6]]
*
* // equivalent
* const x = [1, 3, 5],
* y = [2, 4, 6],
* result = [];
* for(let i = 0; i < x.length; i++) {
* for(let j = 0; j < y.length; j++) {
* const _x = x[i], _y = y[j];
* if(_x < _y) result.push([_x, _y] as const)
* }
* }
* ```
*
* @see {@link bindTo}
* @see {@link Do}
* @see {@link let_ let}
*
* @category do notation
* @since 3.2.0
*/
<A extends object, N extends string, B>(
self: ReadonlyArray<A>,
tag: Exclude<N, keyof A>,
f: (a: NoInfer<A>) => ReadonlyArray<B>
): Array<{ [K in N | keyof A]: K extends keyof A ? A[K] : B }>
} = internalDoNotation.bind<ReadonlyArrayTypeLambda>(map, flatMap) as any
/**
* The "do simulation" for array allows you to sequentially apply operations to the elements of arrays, just as nested loops allow you to go through all combinations of elements in an arrays.
*
* It can be used to simulate "array comprehension".
* It's a technique that allows you to create new arrays by iterating over existing ones and applying specific **conditions** or **transformations** to the elements. It's like assembling a new collection from pieces of other collections based on certain rules.
*
* Here's how the do simulation works:
*
* 1. Start the do simulation using the `Do` value
* 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Array` values
* 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
* 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
* 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const doResult = pipe(
* Array.Do,
* Array.bind("x", () => [1, 3, 5]),
* Array.bind("y", () => [2, 4, 6]),
* Array.filter(({ x, y }) => x < y), // condition
* Array.map(({ x, y }) => [x, y] as const) // transformation
* )
* console.log(doResult) // [[1, 2], [1, 4], [1, 6], [3, 4], [3, 6], [5, 6]]
*
* // equivalent
* const x = [1, 3, 5],
* y = [2, 4, 6],
* result = [];
* for(let i = 0; i < x.length; i++) {
* for(let j = 0; j < y.length; j++) {
* const _x = x[i], _y = y[j];
* if(_x < _y) result.push([_x, _y] as const)
* }
* }
* ```
*
* @see {@link bindTo}
* @see {@link Do}
* @see {@link let_ let}
*
* @category do notation
* @since 3.2.0
*/
export const bindTo: {
/**
* The "do simulation" for array allows you to sequentially apply operations to the elements of arrays, just as nested loops allow you to go through all combinations of elements in an arrays.
*
* It can be used to simulate "array comprehension".
* It's a technique that allows you to create new arrays by iterating over existing ones and applying specific **conditions** or **transformations** to the elements. It's like assembling a new collection from pieces of other collections based on certain rules.
*
* Here's how the do simulation works:
*
* 1. Start the do simulation using the `Do` value
* 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Array` values
* 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
* 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
* 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const doResult = pipe(
* Array.Do,
* Array.bind("x", () => [1, 3, 5]),
* Array.bind("y", () => [2, 4, 6]),
* Array.filter(({ x, y }) => x < y), // condition
* Array.map(({ x, y }) => [x, y] as const) // transformation
* )
* console.log(doResult) // [[1, 2], [1, 4], [1, 6], [3, 4], [3, 6], [5, 6]]
*
* // equivalent
* const x = [1, 3, 5],
* y = [2, 4, 6],
* result = [];
* for(let i = 0; i < x.length; i++) {
* for(let j = 0; j < y.length; j++) {
* const _x = x[i], _y = y[j];
* if(_x < _y) result.push([_x, _y] as const)
* }
* }
* ```
*
* @see {@link bindTo}
* @see {@link Do}
* @see {@link let_ let}
*
* @category do notation
* @since 3.2.0
*/
<N extends string>(tag: N): <A>(self: ReadonlyArray<A>) => Array<{ [K in N]: A }>
/**
* The "do simulation" for array allows you to sequentially apply operations to the elements of arrays, just as nested loops allow you to go through all combinations of elements in an arrays.
*
* It can be used to simulate "array comprehension".
* It's a technique that allows you to create new arrays by iterating over existing ones and applying specific **conditions** or **transformations** to the elements. It's like assembling a new collection from pieces of other collections based on certain rules.
*
* Here's how the do simulation works:
*
* 1. Start the do simulation using the `Do` value
* 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Array` values
* 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
* 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
* 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const doResult = pipe(
* Array.Do,
* Array.bind("x", () => [1, 3, 5]),
* Array.bind("y", () => [2, 4, 6]),
* Array.filter(({ x, y }) => x < y), // condition
* Array.map(({ x, y }) => [x, y] as const) // transformation
* )
* console.log(doResult) // [[1, 2], [1, 4], [1, 6], [3, 4], [3, 6], [5, 6]]
*
* // equivalent
* const x = [1, 3, 5],
* y = [2, 4, 6],
* result = [];
* for(let i = 0; i < x.length; i++) {
* for(let j = 0; j < y.length; j++) {
* const _x = x[i], _y = y[j];
* if(_x < _y) result.push([_x, _y] as const)
* }
* }
* ```
*
* @see {@link bindTo}
* @see {@link Do}
* @see {@link let_ let}
*
* @category do notation
* @since 3.2.0
*/
<A, N extends string>(self: ReadonlyArray<A>, tag: N): Array<{ [K in N]: A }>
} = internalDoNotation.bindTo<ReadonlyArrayTypeLambda>(map) as any
const let_: {
<N extends string, B, A extends object>(
tag: Exclude<N, keyof A>,
f: (a: NoInfer<A>) => B
): (self: ReadonlyArray<A>) => Array<{ [K in N | keyof A]: K extends keyof A ? A[K] : B }>
<N extends string, A extends object, B>(
self: ReadonlyArray<A>,
tag: Exclude<N, keyof A>,
f: (a: NoInfer<A>) => B
): Array<{ [K in N | keyof A]: K extends keyof A ? A[K] : B }>
} = internalDoNotation.let_<ReadonlyArrayTypeLambda>(map) as any
export {
/**
* The "do simulation" for array allows you to sequentially apply operations to the elements of arrays, just as nested loops allow you to go through all combinations of elements in an arrays.
*
* It can be used to simulate "array comprehension".
* It's a technique that allows you to create new arrays by iterating over existing ones and applying specific **conditions** or **transformations** to the elements. It's like assembling a new collection from pieces of other collections based on certain rules.
*
* Here's how the do simulation works:
*
* 1. Start the do simulation using the `Do` value
* 2. Within the do simulation scope, you can use the `bind` function to define variables and bind them to `Array` values
* 3. You can accumulate multiple `bind` statements to define multiple variables within the scope
* 4. Inside the do simulation scope, you can also use the `let` function to define variables and bind them to simple values
* 5. Regular `Option` functions like `map` and `filter` can still be used within the do simulation. These functions will receive the accumulated variables as arguments within the scope
*
* **Example**
*
* ```ts
* import { Array, pipe } from "effect"
*
* const doResult = pipe(
* Array.Do,
* Array.bind("x", () => [1, 3, 5]),
* Array.bind("y", () => [2, 4, 6]),
* Array.filter(({ x, y }) => x < y), // condition
* Array.map(({ x, y }) => [x, y] as const) // transformation
* )
* console.log(doResult) // [[1, 2], [1, 4], [1, 6], [3, 4], [3, 6], [5, 6]]
*
* // equivalent
* const x = [1, 3, 5],
* y = [2, 4, 6],
* result = [];
* for(let i = 0; i < x.length; i++) {
* for(let j = 0; j < y.length; j++) {
* const _x = x[i], _y = y[j];
* if(_x < _y) result.push([_x, _y] as const)
* }
* }
*
* ```
*
* @see {@link bindTo}
* @see {@link bind}
* @see {@link Do}
*
* @category do notation
* @since 3.2.0
*/
let_ as let
}
Latest Blog Posts
- MCP Moves to the Linux Foundation: Neutral Stewardship for Agentic InfrastructureBy Om-Shree-0709 on .mcpanthropicLinux Foundation
MCP directory API
We provide all the information about MCP servers via our MCP API.
curl -X GET 'https://glama.ai/api/mcp/v1/servers/ssv445/lorem-ipsum-mcp'
If you have feedback or need assistance with the MCP directory API, please join our Discord server