type-plus
    Preparing search index...

    Type Alias PadStart<A, MaxLength, PadWith>

    PadStart: number extends A["length"]
        ? ArrayPlus.PadStart<A, MaxLength, PadWith>
        : TuplePlus.PadStart<A, MaxLength, PadWith>

    Pads the start of an array or tuple with PadWith.

    ⚗️ transform

    Type Parameters

    • A extends readonly unknown[]
    • MaxLength extends number
    • PadWith = unknown
    // Padding array
    PadStart<number[], 1, string> // [string, ...number[]]

    // Ignore if the type is compatible
    PadStart<number[], 2, number> // number[]
    PadStart<number[], 3, 1> // number[]

    // Padding tuple
    PadStart<[1, 2, 3], 5, 0> // [0, 0, 1, 2, 3]

    // Ignore if MaxLength is less than the length of the tuple
    PadStart<[1, 2, 3], 5, 0> // [0, 0, 1, 2, 3]

    // Default to unknown
    PadStart<[1, 2, 3], 5> // [unknown, unknown, 1, 2, 3]