ts-data-forge
    Preparing search index...

    Function map

    • Creates a new array by transforming each element with a mapping function.

      Type Parameters

      • const Ar extends readonly unknown[] & {} & Readonly<
            {
                "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
            },
        >
      • B

      Parameters

      Returns ChangeArrayElement<Ar, B>

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

      const doubled = Arr.map(numbers, (value) => value * 2);

      const indexed = Arr.map<number, string>(
        (value, index) => `${index}:${value}`,
      )(numbers);

      assert.deepStrictEqual(doubled, [2, 4, 6]);

      assert.deepStrictEqual(indexed, ['0:1', '1:2', '2:3']);

    • Creates a new array by transforming each element with a mapping function.

      Type Parameters

      • const Ar extends readonly unknown[]
      • B

      Parameters

      Returns Readonly<{ [K in keyof Ar]: B }>

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

      const doubled = Arr.map(numbers, (value) => value * 2);

      const indexed = Arr.map<number, string>(
        (value, index) => `${index}:${value}`,
      )(numbers);

      assert.deepStrictEqual(doubled, [2, 4, 6]);

      assert.deepStrictEqual(indexed, ['0:1', '1:2', '2:3']);

    • Creates a new array by transforming each element with a mapping function.

      Type Parameters

      • A
      • B

      Parameters

      • mapFn: (a: A, index: Uint32) => B

      Returns <
          const Ar extends
              readonly A[] & {} & Readonly<
                  {
                      "TSTypeForgeInternals--edd2f9ce-7ca5-45b0-9d1a-bd61b9b5d9c3": unknown;
                  },
              >,
      >(
          array: Ar,
      ) => ChangeArrayElement<Ar, B> & <const Ar extends readonly A[]>(
          array: Ar,
      ) => Readonly<{ [K in keyof Ar]: B }>

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

      const doubled = Arr.map(numbers, (value) => value * 2);

      const indexed = Arr.map<number, string>(
        (value, index) => `${index}:${value}`,
      )(numbers);

      assert.deepStrictEqual(doubled, [2, 4, 6]);

      assert.deepStrictEqual(indexed, ['0:1', '1:2', '2:3']);

    Settings
    Member Visibility