ts-data-forge
    Preparing search index...

    Function toInserted

    • Returns a new array with a value inserted at the specified index.

      Type Parameters

      • const Ar extends readonly unknown[]
      • const V = Ar[number]

      Parameters

      • array: Ar
      • index: ArgArrayIndexWithNegative<Ar>
      • newValue: V

      Returns IsFixedLengthList<Ar> extends true
          ? MakeTupleImpl<
              Ar[number]
              | V,
              `${CastToNumber<Increment<Ar["length"]>>}`,
              [],
          >
          : readonly [Ar[number] | V, Ar[number] | V]

      const numbers = [1, 2, 4] as const;

      const withThree = Arr.toInserted(numbers, 2, 3);
      const appendFive = Arr.toInserted(3, 5)(numbers);

      assert.deepStrictEqual(withThree, [1, 2, 3, 4]);
      assert.deepStrictEqual(appendFive, [1, 2, 4, 5]);

    • Returns a new array with a value inserted at the specified index.

      Type Parameters

      • const V

      Parameters

      • index: ArgArrWithNegative
      • newValue: V

      Returns <const Ar extends readonly unknown[]>(
          array: Ar,
      ) => IsFixedLengthList<Ar> extends true
          ? MakeTupleImpl<
              V
              | Ar[number],
              `${CastToNumber<Increment<Ar["length"]>>}`,
              [],
          >
          : readonly [V | Ar[number], V | Ar[number]]

      const numbers = [1, 2, 4] as const;

      const withThree = Arr.toInserted(numbers, 2, 3);
      const appendFive = Arr.toInserted(3, 5)(numbers);

      assert.deepStrictEqual(withThree, [1, 2, 3, 4]);
      assert.deepStrictEqual(appendFive, [1, 2, 4, 5]);

    Settings

    Member Visibility