ts-data-forge
    Preparing search index...

    Function toPushed

    • Returns a new array with a value appended to the end.

      Type Parameters

      • const Ar extends readonly unknown[]
      • const V

      Parameters

      • array: Ar
      • newValue: V

      Returns readonly [Ar, V] & readonly [V | Ar[number], V | Ar[number]] & Readonly<
          { MinLength: readonly [0, 0] },
      > & Readonly<
          {
              "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
          },
      >

      const base = [1, 2] as const;

      const appended = Arr.toPushed(base, 3);

      const appendedCurried = Arr.toPushed(4)(base);

      // The result is guaranteed non-empty, so it is assignable to NonEmptyArray.
      const nonEmpty: NonEmptyArray<number> = appended;

      assert.deepStrictEqual<readonly number[]>(appended, [1, 2, 3]);

      assert.deepStrictEqual<readonly number[]>(appendedCurried, [1, 2, 4]);

      assert.isTrue(nonEmpty.length >= 1);

    • Returns a new array with a value appended to the end.

      Type Parameters

      • const V

      Parameters

      • newValue: V

      Returns <const Ar extends readonly unknown[]>(
          array: Ar,
      ) => readonly [Ar, V] & readonly [V | Ar[number], V | Ar[number]] & Readonly<
          { MinLength: readonly [0, 0] },
      > & Readonly<
          {
              "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
          },
      >

      const base = [1, 2] as const;

      const appended = Arr.toPushed(base, 3);

      const appendedCurried = Arr.toPushed(4)(base);

      // The result is guaranteed non-empty, so it is assignable to NonEmptyArray.
      const nonEmpty: NonEmptyArray<number> = appended;

      assert.deepStrictEqual<readonly number[]>(appended, [1, 2, 3]);

      assert.deepStrictEqual<readonly number[]>(appendedCurried, [1, 2, 4]);

      assert.isTrue(nonEmpty.length >= 1);

    Settings
    Member Visibility