Add array.copyWithin

packages/immutadot/src/array/copyWithin.js

@@ -0,0 +1,22 @@
+import { applyArrayMethod } from './applyArrayMethod'
+
+/**
+ * Shallow copies part of an array to another location in the same array, without modifying its size.
+ * @function
+ * @memberof array
+ * @param {Object} object The object to modify.
+ * @param {Array|string} path The path of the property to set.
+ * @param {number} target Zero based index at which to copy the sequence to.
+ * @param {number} [start] Zero based index at which to start copying elements from.
+ * @param {number} [end] Zero based index at which to end copying elements from.
+ * @return {Object} Returns the updated object.
+ * @example copyWithin({ nested: { prop: [1, 2, 3, 4, 5] } }, 'nested.prop', 0, 3, 4) // => { nested: { prop: [4, 2, 3, 4, 5] } }
+ * @see {@link https://mdn.io/Array.prototype.copyWithin|Array.prototype.copyWithin} for more information.
+ * @since 2.0.0
+ */
+const copyWithin = applyArrayMethod(Array.prototype.copyWithin, {
+  arity: 1,
+  mutating: true,
+})
+
+export { copyWithin }

packages/immutadot/src/array/copyWithin.spec.js

@@ -0,0 +1,23 @@
+/* eslint-env jest */
+import { copyWithin } from 'array'
+import { immutaTest } from 'test.utils'
+
+describe('array.copyWithin', () => {
+  it('should copy within an array', () => {
+    immutaTest({
+      nested: {
+        prop: [1, 2, 3, 4, 5],
+      },
+      other: {},
+    }, ['nested.prop'], (input, path) => {
+      const output = copyWithin(input, path, 0, 3, 4)
+      expect(output).toEqual({
+        nested: {
+          prop: [4, 2, 3, 4, 5],
+        },
+        other: {},
+      })
+      return output
+    })
+  })
+})

packages/immutadot/src/array/index.js

@@ -4,9 +4,10 @@
  * @since 0.1.6
  */
 
-export { filter } from './filter'
 export { concat } from './concat'
+export { copyWithin } from './copyWithin'
 export { fill } from './fill'
+export { filter } from './filter'
 export { map } from './map'
 export { pop } from './pop'
 export { push } from './push'

packages/immutadot/src/index.js

@@ -1,5 +1,6 @@
 export {
   concat as arrayConcat,
+  copyWithin,
   fill,
   filter,
   map,