refactor(utils)!: [includes] order position arg before identity

Signed-off-by: Lexus Drumgold <unicornware@flexdevelopment.llc>

Author: unicornware

src/utils/__tests__/includes.spec.ts

@@ -11,37 +11,37 @@ describe('unit:utils/includes', () => {
     // Arrange
     const cases: Parameters<typeof testSubject>[] = [
       ['abc', 'z'],
-      ['abc', 'a', null, 1],
+      ['abc', 'a', 1, null],
       [['a', 'b', 'c'], 'z'],
-      [['a', 'b', 'c'], 'a', undefined, 1]
+      [['a', 'b', 'c'], 'a', 1]
     ]
 
     // Act + Expect
-    cases.forEach(([value, target, identity, position]) => {
-      expect(testSubject(value, target, identity, position)).to.be.false
+    cases.forEach(([value, target, position, identity]) => {
+      expect(testSubject(value, target, position, identity)).to.be.false
     })
   })
 
   it('should return true if value includes target', () => {
     // Arrange
     const cases: Parameters<typeof testSubject>[] = [
       ['foobar', 'foo'],
-      ['foobar', 'bar', null, 3],
-      [[faker.number.int(), { x: 0, y: 0 }], { x: 0, y: 0 }, undefined, 1],
+      ['foobar', 'bar', 3],
+      [[faker.number.int(), { x: 0, y: 0 }], { x: 0, y: 0 }, 1],
       [
         [faker.number.int(), { x: 0, y: 0 }],
         { x: 0, y: 0 },
+        1,
         item => {
           const { x, y = Number.NaN } = cast<{ x: number; y?: number }>(item)
           return `[${x},${y}]`
-        },
-        1
+        }
       ]
     ]
 
     // Act + Expect
-    cases.forEach(([value, target, identity, position]) => {
-      expect(testSubject(value, target, identity, position)).to.be.true
+    cases.forEach(([value, target, position, identity]) => {
+      expect(testSubject(value, target, position, identity)).to.be.true
     })
   })
 })

src/utils/diff.ts

@@ -30,7 +30,7 @@ const diff = <T, K extends PropertyKey = PropertyKey>(
 ): T[] => {
   return intersects(arr1, arr2, identity)
     ? arr1.reduce<T[]>((acc, item) => {
-        return includes(arr2, item, identity) ? acc : [...acc, item]
+        return includes(arr2, item, null, identity) ? acc : [...acc, item]
       }, [])
     : [...arr1]
 }

src/utils/includes.ts

@@ -3,7 +3,7 @@
  * @module tutils/utils/includes
  */
 
-import type { Fn, IfString, NIL, Nilable, PropertyKey } from '#src/types'
+import type { Fn, Nilable, PropertyKey } from '#src/types'
 import cast from './cast'
 import equal from './equal'
 import isString from './is-string'
@@ -36,8 +36,8 @@ const includes = <
 >(
   value: T,
   target: unknown,
-  identity?: IfString<T, NIL, Nilable<Fn<[T[number]], K>>>,
-  position?: Nilable<number>
+  position?: Nilable<number>,
+  identity?: Nilable<Fn<[T[number]], K>>
 ): boolean => {
   position ??= 0
 

src/utils/intersection.ts

@@ -27,6 +27,6 @@ const intersection = <T, K extends PropertyKey = PropertyKey>(
   arr1: readonly T[],
   arr2: readonly T[],
   identity?: Nilable<Fn<[T], K>>
-): T[] => select(arr1, item => includes(arr2, item, identity))
+): T[] => select(arr1, item => includes(arr2, item, null, identity))
 
 export default intersection

src/utils/pull.ts

@@ -28,6 +28,6 @@ const pull = <T, K extends PropertyKey = PropertyKey, U = T>(
   arr: readonly T[],
   drop: readonly T[],
   identity?: Nilable<Fn<[T], K>>
-): U[] => select(arr, item => !includes(drop, item, identity))
+): U[] => select(arr, item => !includes(drop, item, null, identity))
 
 export default pull

src/utils/unique.ts

@@ -29,7 +29,7 @@ const unique = <T, K extends PropertyKey = PropertyKey, U = T>(
 ): U[] => {
   return cast(
     arr.reduce<T[]>((acc, item) => {
-      return includes(acc, item, identity) ? acc : [...acc, item]
+      return includes(acc, item, null, identity) ? acc : [...acc, item]
     }, [])
   )
 }