JS Utils Kit
    Preparing search index...

    Function unique

    • Returns a new array with duplicate values removed.

      Uniqueness is determined using Set, meaning object uniqueness is based on reference equality.

      Type Parameters

      • T

      Parameters

      • array: readonly T[]

        The source array.

      • __namedParameters: { compareFn?: (a: T, b: T) => number; sort?: boolean } = {}
        • OptionalcompareFn?: (a: T, b: T) => number

          Custom compare function for sorting.

        • Optionalsort?: boolean

          Whether to sort the result.

          false
          

      Returns T[]

      unique([3, 1, 2, 1]);
      // [3, 1, 2]

      unique([3, 1, 2, 1], { sort: true });
      // [1, 2, 3]

      const user1 = { id: 1, name: 'Alice' };
      const user2 = { id: 2, name: 'Bob' };
      const user3 = { id: 3, name: 'Charlie' };
      const users = [user3, user1, user2, user1];

      unique(users, {
      sort: true,
      compareFn: (a, b) => a.id - b.id,
      });

      // [
      // { id: 1, name: 'Alice' },
      // { id: 2, name: 'Bob' },
      // { id: 3, name: 'Charlie' }
      // ]