ts-data-forge
    Preparing search index...

    Function toSorted

    • Sorts an array.

      Type Parameters

      • const Ar extends readonly number[]

      Parameters

      • array: Ar
      • Optionalcomparator: (x: Ar[number], y: Ar[number]) => number

      Returns SortedResult<Ar>

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

      const words = ['banana', 'apple', 'cherry'] as const;

      const ascendingNumbers = Arr.toSorted(numbers);

      const alphabetical = Arr.toSorted(words, (left, right) =>
        left.localeCompare(right),
      );

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

      const expectedWords = ['apple', 'banana', 'cherry'] as const;

      assert.deepStrictEqual(ascendingNumbers, expectedNumbers);

      assert.deepStrictEqual(alphabetical, expectedWords);

    • Sorts an array.

      Type Parameters

      • const Ar extends readonly unknown[]

      Parameters

      • array: Ar
      • comparator: (x: Ar[number], y: Ar[number]) => number

      Returns SortedResult<Ar>

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

      const words = ['banana', 'apple', 'cherry'] as const;

      const ascendingNumbers = Arr.toSorted(numbers);

      const alphabetical = Arr.toSorted(words, (left, right) =>
        left.localeCompare(right),
      );

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

      const expectedWords = ['apple', 'banana', 'cherry'] as const;

      assert.deepStrictEqual(ascendingNumbers, expectedNumbers);

      assert.deepStrictEqual(alphabetical, expectedWords);

    Settings
    Member Visibility