1
0
mirror of https://github.com/lensapp/lens.git synced 2025-05-20 05:10:56 +00:00
lens/packages/utility-features/utilities/src/tuple.ts
Sebastian Malton 271f8860e2 chore: Fixup remaining type errors from core
Signed-off-by: Sebastian Malton <sebastian@malton.name>
2023-06-01 09:27:46 -04:00

73 lines
2.2 KiB
TypeScript

/**
* Copyright (c) OpenLens Authors. All rights reserved.
* Licensed under MIT License. See LICENSE in root directory for more information.
*/
import { array } from "./array";
/**
* A strict N-tuple of type T
*/
export type Tuple<T, N extends number> = N extends N
? number extends N
? T[]
: TupleOfImpl<T, N, []>
: never;
type TupleOfImpl<T, N extends number, R extends unknown[]> = R["length"] extends N
? R
: TupleOfImpl<T, N, [T, ...R]>;
/**
* A strict N-tuple of type T
*/
export type ReadonlyTuple<T, N extends number> = N extends N
? number extends N
? T[]
: ReadonlyTupleOfImpl<T, N, []>
: never;
type ReadonlyTupleOfImpl<T, N extends number, R extends readonly unknown[]> = R["length"] extends N
? R
: ReadonlyTupleOfImpl<T, N, readonly [T, ...R]>;
/**
* Iterates over `sources` yielding full tuples until one of the tuple arrays
* is empty. Then it returns a tuple with the rest of each of tuples
* @param sources The source arrays
* @yields A tuple of the next element from each of the sources
* @returns The tuple of all the sources as soon as at least one of the sources is exhausted
*/
function zip<T>(...sources: Tuple<T[], 0>): Iterator<Tuple<T, 0>, Tuple<T[], 0>>;
function zip<T>(...sources: Tuple<T[], 1>): Iterator<Tuple<T, 1>, Tuple<T[], 1>>;
function zip<T>(...sources: Tuple<T[], 2>): Iterator<Tuple<T, 2>, Tuple<T[], 2>>;
function* zip<T, N extends number>(...sources: Tuple<T[], N>): Iterator<Tuple<T, N>, Tuple<T[], N>> {
const maxSafeLength = Math.min(...sources.map(source => source.length));
for (let i = 0; i < maxSafeLength; i += 1) {
yield sources.map(source => source[i]) as Tuple<T, N>;
}
return sources.map(source => source.slice(maxSafeLength)) as Tuple<T[], N>;
}
/**
* Returns a `length` tuple filled with copies of `value`
* @param length The size of the tuple
* @param value The value for each of the tuple entries
*/
function filled<T, L extends number>(length: L, value: T): Tuple<T, L> {
return array.filled(length, value) as Tuple<T, L>;
}
/**
* A function for converting an explicit array to a tuple but without the `readonly` typing
*/
function from<T extends any[]>(...args: T): [...T] {
return args;
}
export const tuple = {
zip,
filled,
from,
};