Variable lengthConst

Type Declaration

• • <const Ar extends readonly unknown[]>(
        array: Ar,
    ): Ar extends readonly [unknown, unknown]
        ? IntersectBrand<PositiveNumber, Uint32>
        : Uint32

  • Returns the size (length) of an array.

    Type Parameters

    • const Ar extends readonly unknown[]

    Parameters

    • array: Ar

    Returns Ar extends readonly [unknown, unknown]
        ? IntersectBrand<PositiveNumber, Uint32>
        : Uint32

    Example

    const numbers = [1, 2, 3] as const;
    const letters: string[] = [];
    
    const sizeOfNumbers = Arr.size(numbers);
    const sizeOfLetters = Arr.size(letters);
    
    assert(sizeOfNumbers === 3);
    assert(sizeOfLetters === 0);
    Copy