effect-io-ai

Package: effect
Module: Array

Array.unprepend

Splits a non-empty array into its first element and the remaining elements.

When to use

Use when you have a NonEmptyReadonlyArray and need both its first element and the remaining elements as separate values.

Details

Returns a tuple [head, tail] and requires a NonEmptyReadonlyArray.

Example (Destructuring head and tail)

import { Array } from "effect"

const result = Array.unprepend([1, 2, 3, 4])
console.log(result) // [1, [2, 3, 4]]

See

• unappend for splitting a non-empty array into init and last
• headNonEmpty for getting only the first element
• tailNonEmpty for getting only the elements after the first

Signature

declare const unprepend: <A>(self: NonEmptyReadonlyArray<A>) => [firstElement: A, remainingElements: Array<A>]

Source

Since v2.0.0