functionalscript/types/array/module.f.d.ts

FunctionalScript is a purely functional subset of JavaScript

/**
 * JavaScript immutable arrays.
 *
 * @module
 */
export type Array1<T> = readonly [T];
export type Index1 = 0;
export type Array2<T> = readonly [T, T];
export declare const isArray2: <T>(a: readonly T[]) => a is Array2<T>;
export type Tuple2<T0, T1> = readonly [T0, T1];
export type Index2 = 0 | 1;
export type Array3<T> = readonly [T, T, T];
export type Tuple3<T0, T1, T2> = readonly [T0, T1, T2];
export type Index3 = Index2 | 2;
export type Array4<T> = readonly [T, T, T, T];
export type Index4 = Index3 | 3;
export type Array5<T> = readonly [T, T, T, T, T];
export type Index5 = Index4 | 4;
export type Array8<T> = readonly [T, T, T, T, T, T, T, T];
export type Index8 = Index5 | 5 | 6 | 7;
export type Array16<T> = readonly [T, T, T, T, T, T, T, T, T, T, T, T, T, T, T, T];
export type Index16 = Index8 | 8 | 9 | 10 | 11 | 12 | 13 | 14 | 15;
export type Array1_5<T> = Array1<T> | Array2<T> | Array3<T> | Array4<T> | Array5<T>;
export type KeyOf<T> = T extends Array1<infer _> ? Index1 : T extends Array2<infer _> ? Index2 : T extends Array3<infer _> ? Index3 : T extends Array4<infer _> ? Index4 : T extends Array5<infer _> ? Index5 : T extends Array8<infer _> ? Index8 : T extends Array16<infer _> ? Index16 : T extends readonly (infer _)[] ? number : never;
export declare const at: (i: number) => <T>(a: readonly T[]) => T | null;
export declare const first: <T>(_: readonly T[]) => T | null;
export declare const last: <T>(a: readonly T[]) => T | null;
export declare const tail: <T>(a: readonly T[]) => readonly T[] | null;
export declare const splitFirst: <T>(a: readonly T[]) => readonly [T, readonly T[]] | null;
export declare const head: <T>(a: readonly T[]) => readonly T[] | null;
export declare const splitLast: <T>(a: readonly T[]) => readonly [readonly T[], T] | null;
/**
 * An empty immutable array.
 *
 * Two JavaScript empty arrays are different and has to have two different values.
 * Usually, it requires memory allocation. If we use the same an empty array everywhere,
 * we may minimize memory a number of memory allocations.
 */
export declare const empty: readonly [];