Array135

Constructors

allocateconstCreates a new Array of the specified length with all slots uninitialized.ArrayconstExposes the global array constructor.emptyconstCreates an empty array.ensureconstNormalizes a value that is either a single element or an array into an array.fromIterableconstConverts an Iterable to an Array.makeconstCreates a NonEmptyArray from one or more elements.makeByconstCreates a NonEmptyArray of length n where element i is computed by f(i).ofconstWraps a single value in a NonEmptyArray.rangeconstCreates a NonEmptyArray containing a range of integers, inclusive on both ends.replicateconstCreates a NonEmptyArray containing a value repeated n times.unfoldconstBuilds an array by repeatedly applying a function to a seed value.

Models

NonEmptyArraytypeA mutable array guaranteed to have at least one element.NonEmptyReadonlyArraytypeA readonly array guaranteed to have at least one element.

Guards

isArrayconstChecks whether a value is an Array.isArrayEmptyconstChecks whether a mutable Array is empty, narrowing the type to [].isArrayNonEmptyconstChecks whether a mutable Array is non-empty, narrowing the type to NonEmptyArray.isReadonlyArrayEmptyconstChecks whether a ReadonlyArray is empty, narrowing the type to readonly [].isReadonlyArrayNonEmptyconstChecks whether a ReadonlyArray is non-empty, narrowing the type to NonEmptyReadonlyArray.

Getters

dropconstRemoves the first n elements, creating a new array.dropRightconstRemoves the last n elements, creating a new array.dropWhileconstDrops elements from the start while the predicate holds, returning the rest.dropWhileFilterconstDrops elements from the start while a Filter succeeds.getconstReads an element at the given index safely, returning Option.some or Option.none if the index is out of bounds.headconstReturns the first element of an array safely wrapped in Option.some, or Option.none if the array is empty.headNonEmptyconstReturns the first element of a NonEmptyReadonlyArray directly (no Option wrapper).initfunctionReturns all elements except the last safely, wrapped in an Option.initNonEmptyconstReturns all elements except the last of a NonEmptyReadonlyArray.lastconstReturns the last element of an array safely wrapped in Option.some, or Option.none if the array is empty.lastNonEmptyconstReturns the last element of a NonEmptyReadonlyArray directly (no Option wrapper).lengthconstReturns the number of elements in a ReadonlyArray.tailfunctionReturns all elements except the first safely, wrapped in an Option.tailNonEmptyconstReturns all elements except the first of a NonEmptyReadonlyArray.takeconstKeeps the first n elements, creating a new array.takeRightconstKeeps the last n elements, creating a new array.takeWhileconstTakes elements from the start while the predicate holds, stopping at the first element that fails.takeWhileFilterconstTakes elements from the start while a Filter succeeds, collecting transformed values.

Elements

cartesianconstComputes the cartesian product of two arrays, returning all pairs as tuples.cartesianWithconstComputes the cartesian product of two arrays, applying a combiner to each pair.chopconstApplies a function repeatedly to consume prefixes of the array and collect the values it produces.containsconstChecks whether an array contains a value, using Equal.equivalence() for comparison.containsWithconstReturns a membership-test function using a custom equivalence.copyconstCreates a shallow copy of an array.dedupeconstRemoves duplicates using Equal.equivalence(), preserving the order of the first occurrence.dedupeAdjacentconstRemoves consecutive duplicate elements using Equal.equivalence().dedupeAdjacentWithconstRemoves consecutive duplicate elements using a custom equivalence.dedupeWithconstRemoves duplicates using a custom equivalence, preserving the order of the first occurrence.differenceconstComputes elements in the first array that are not in the second, using Equal.equivalence().differenceWithconstComputes elements in the first array that are not in the second, using a custom equivalence.everyconstChecks whether all elements satisfy the predicate.findFirstconstReturns the first element matching a predicate, refinement, or mapping function, wrapped in Option.findFirstIndexconstReturns the index of the first element matching the predicate, wrapped in an Option.findFirstWithIndexconstReturns the first selected value together with its index, wrapped in an Option.findLastconstReturns the last element matching a predicate, refinement, or mapping function, wrapped in Option.findLastIndexconstReturns the index of the last element matching the predicate, wrapped in an Option.forEachconstRuns a side-effect for each element.insertAtconstInserts an element at the specified index safely, returning a new NonEmptyArray wrapped in an Option.intersectionconstComputes the intersection of two arrays using Equal.equivalence().intersectionWithconstComputes the intersection of two arrays using a custom equivalence.intersperseconstPlaces a separator element between every pair of elements.maxconstReturns the maximum element of a non-empty array according to the given Order.minconstReturns the minimum element of a non-empty array according to the given Order.modifyconstApplies a function to the element at the specified index safely, returning the updated array in Option.some.modifyHeadNonEmptyconstApplies a function to the first element of a non-empty array, returning a new array.modifyLastNonEmptyconstApplies a function to the last element of a non-empty array, returning a new array.padconstPads or truncates an array to exactly n elements, filling with fill if the array is shorter, or slicing if longer.removeconstRemoves the element at the specified index, returning a new array.replaceconstReplaces the element at the specified index safely with a new value, returning the updated array in Option.some.reverseconstReverses an iterable into a new array.rotateconstTransforms an array by rotating it n steps.setHeadNonEmptyconstReplaces the first element of a non-empty array with a new value.setLastNonEmptyconstReplaces the last element of a non-empty array with a new value.someconstChecks whether at least one element satisfies the predicate.sortWithconstSorts an array by a derived key using a mapping function and an Order for that key.unionconstComputes the union of two arrays, removing duplicates using Equal.equivalence().unionWithconstComputes the union of two arrays using a custom equivalence, removing duplicates.

Mapping

extendconstApplies a function to each suffix of the array (starting from each index), collecting the results.mapconstTransforms each element using a function, returning a new array.

Filtering

filterconstKeeps only elements satisfying a predicate (or refinement).filterMapconstKeeps transformed values for elements where a Filter succeeds.getFailuresconstExtracts all failure values from an iterable of Results, discarding successes.getSomesconstExtracts all Some values from an iterable of Options, discarding Nones.getSuccessesconstExtracts all success values from an iterable of Results, discarding failures.partitionconstSplits an iterable using a Filter into failures and successes.separateconstSeparates an iterable of Results into failure values and success values.

Sequencing

flatMapconstMaps each element to an array and flattens the results into a single array.flatMapNullishOrconstMaps each element with a nullable-returning function, keeping only non-null / non-undefined results.flattenconstFlattens a nested array of arrays into a single array.

Combining

appendconstAdds a single element to the end of an iterable, returning a NonEmptyArray.appendAllconstConcatenates two iterables into a single array.prependconstAdds a single element to the front of an iterable, returning a NonEmptyArray.prependAllconstPrepends all elements from a prefix iterable to the front of an array.

Converting

fromNullishOrconstConverts a nullable value to an array: null/undefined becomes [], anything else becomes [value].fromOptionconstConverts an Option to an array: Some(a) becomes [a], None becomes [].fromRecordconstConverts a record into an array of [key, value] tuples.

Do Notation

bindconstAdds a new array variable to a do-notation scope, producing the cartesian product with all previous bindings.bindToconstWraps each array element in an object with the given key, starting a do-notation scope.DoconstProvides the starting point for the "do simulation" — an array comprehension pattern.

Folding

countByconstComputes the number of elements in an iterable that satisfy a predicate.getReadonlyReducerConcatfunctionReturns a Reducer that combines ReadonlyArray values by concatenation.joinconstJoins string elements with a separator.makeReducerConcatfunctionReturns a Reducer that combines Array values by concatenation.mapAccumconstMaps over an array while threading an accumulator through each step, returning both the final state and the mapped array.reduceconstFolds an iterable from left to right into a single value.reduceRightconstFolds an iterable from right to left into a single value.scanconstFolds left-to-right while keeping every intermediate accumulator value.scanRightconstFolds right-to-left while keeping every intermediate accumulator value.

Grouping

groupconstGroups consecutive equal elements using Equal.equivalence().groupByconstGroups elements into a record by a key-returning function.groupWithconstGroups consecutive equal elements using a custom equivalence function.

Instances

makeEquivalenceconstCreates an Equivalence for arrays based on an element Equivalence.makeOrderconstCreates an Order for arrays based on an element Order.

Lifting

liftNullishOrconstLifts a nullable-returning function into one that returns an array: null/undefined becomes [], anything else becomes [value].liftOptionconstLifts an Option-returning function into one that returns an array: Some(a) becomes [a], None becomes [].liftPredicateconstLifts a predicate into an array: returns [value] if the predicate holds, [] otherwise.liftResultconstLifts a Result-returning function into one that returns an array: failures produce [], successes produce [value].

Pattern Matching

matchconstPattern-matches on an array, handling empty and non-empty cases separately.matchLeftconstPattern-matches on an array from the left, providing the first element and the remaining elements separately.matchRightconstPattern-matches on an array from the right, providing all elements except the last and the last element separately.

Sorting

sortconstSorts an array by the given Order, returning a new array.sortByconstSorts an array by multiple Orders applied in sequence: the first order is used first; ties are broken by the second order, and so on.

Splitting

chunksOfconstSplits an iterable into chunks of length n.spanconstSplits an iterable into two arrays: the longest prefix where the predicate holds, and the remaining elements.splitconstSplits an iterable into n roughly equal-sized chunks.splitAtconstSplits an iterable into two arrays at the given index.splitAtNonEmptyconstSplits a non-empty array into two parts at the given index.splitWhereconstSplits an iterable at the first element matching the predicate.unappendconstSplits a non-empty array into all elements except the last, and the last element.unprependconstSplits a non-empty array into its first element and the remaining elements.windowconstCreates overlapping sliding windows of size n.

Type Lambdas

ReadonlyArrayTypeLambdainterfaceType lambda for ReadonlyArray, used for higher-kinded type operations.

Unsafe

getUnsafeconstReads an element at the given index, throwing if the index is out of bounds.

Zipping

unzipconstSplits an array of pairs into two arrays.zipconstPairs elements from two iterables by position.zipWithconstCombines elements from two iterables pairwise using a function.

Namespaces

ReadonlyArraynamespaceUtility types for working with ReadonlyArray at the type level.