Interface CollectionOps<A, Self>

Operations specific to collections (List, Set, etc.). These operations don't make sense for single-value containers.

interface CollectionOps<A extends Type, Self> {
    get head(): A | undefined;
    get headOption(): Option<A>;
    get init(): Self;
    get last(): A | undefined;
    get lastOption(): Option<A>;
    get tail(): Self;
    drop(n: number): Self;
    dropRight(n: number): Self;
    dropWhile(p: (a: A) => boolean): Self;
    flatten<B>(): Self;
    take(n: number): Self;
    takeRight(n: number): Self;
    takeWhile(p: (a: A) => boolean): Self;
    toArray<B = A>(): B[];
}

Type Parameters

A extends Type
The element type
Self
The collection type itself for proper return types

Hierarchy (View Summary)

CollectionOps
- FunctypeCollection

Index

Accessors

head headOption init last lastOption tail

Methods

drop dropRight dropWhile flatten take takeRight takeWhile toArray

Accessors

head

get head(): A | undefined
Gets the first element of the collection.

Returns A | undefined

headOption

get headOption(): Option<A>
Gets the first element wrapped in Option.

Returns Option<A>

init

get init(): Self
Gets all elements except the last.

Returns Self

last

get last(): A | undefined
Gets the last element of the collection.

Returns A | undefined

lastOption

get lastOption(): Option<A>
Gets the last element wrapped in Option.

Returns Option<A>

tail

get tail(): Self
Gets all elements except the first.

Returns Self

Methods

drop

drop(n: number): Self
Drops the first n elements from the collection.
Parameters
- n: number
Returns Self

dropRight

dropRight(n: number): Self
Drops the last n elements from the collection.
Parameters
- n: number
Returns Self

dropWhile

dropWhile(p: (a: A) => boolean): Self
Drops elements from the start while the predicate is true.
Parameters
- p: (a: A) => boolean
Returns Self

flatten

flatten<B>(): Self
Flattens a collection of collections into a single collection.
Type Parameters
- B
Returns Self

take

take(n: number): Self
Takes the first n elements from the collection.
Parameters
- n: number
Returns Self

takeRight

takeRight(n: number): Self
Takes the last n elements from the collection.
Parameters
- n: number
Returns Self

takeWhile

takeWhile(p: (a: A) => boolean): Self
Takes elements from the start while the predicate is true.
Parameters
- p: (a: A) => boolean
Returns Self

toArray

toArray<B = A>(): B[]
Converts the collection to an array.
Type Parameters
- B = A
Returns B[]