@d-matrix/utils 1.20.0 → 1.21.0

package/dist/array.d.ts

@@ -1,2 +1,3 @@
-export declare function arrayMoveMutable<T>(array: T[], fromIndex: number, toIndex: number): void;
-export declare function arrayMoveImmutable<T>(array: T[], fromIndex: number, toIndex: number): T[];
+export declare function moveMutable<T>(array: T[], fromIndex: number, toIndex: number): void;
+export declare function moveImmutable<T>(array: T[], fromIndex: number, toIndex: number): T[];
+export declare function moveToStart<T>(array: T[], predicate: (item: T) => boolean): T[];

package/dist/array.js

@@ -1,4 +1,4 @@
-export function arrayMoveMutable(array, fromIndex, toIndex) {
+export function moveMutable(array, fromIndex, toIndex) {
     const startIndex = fromIndex < 0 ? array.length + fromIndex : fromIndex;
     if (startIndex >= 0 && startIndex < array.length) {
         const endIndex = toIndex < 0 ? array.length + toIndex : toIndex;
@@ -6,8 +6,14 @@ export function arrayMoveMutable(array, fromIndex, toIndex) {
         array.splice(endIndex, 0, item);
     }
 }
-export function arrayMoveImmutable(array, fromIndex, toIndex) {
+export function moveImmutable(array, fromIndex, toIndex) {
     const newArray = [...array];
-    arrayMoveMutable(newArray, fromIndex, toIndex);
+    moveMutable(newArray, fromIndex, toIndex);
+    return newArray;
+}
+export function moveToStart(array, predicate) {
+    const newArray = [...array];
+    const index = array.findIndex(predicate);
+    moveMutable(newArray, index, 0);
     return newArray;
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@d-matrix/utils",
   "sideEffects": false,
-  "version": "1.20.0",
+  "version": "1.21.0",
   "description": "A dozen of utils for Front-End Development",
   "main": "dist/index.js",
   "scripts": {

package/readme.md

@@ -487,27 +487,40 @@ removeZeroValueKeys({ a: '', b: 'abc', c: undefined, d: null, e: NaN, f: -1, g:
 
 ## array
 
-- `arrayMoveImmutable<T>(array: T[], fromIndex: number, toIndex: number): T[]`
+- `moveImmutable<T>(array: T[], fromIndex: number, toIndex: number): T[]`
 
 ```js
-import { arrayMoveImmutable } from '@d-matrix/utils';
+import { array } from '@d-matrix/utils';
 
 const input = ['a', 'b', 'c'];
 
-const array1 = arrayMoveImmutable(input, 1, 2);
+const array1 = array.moveImmutable(input, 1, 2);
 console.log(array1);
 //=> ['a', 'c', 'b']
 
-const array2 = arrayMoveImmutable(input, -1, 0);
+const array2 = array.moveImmutable(input, -1, 0);
 console.log(array2);
 //=> ['c', 'a', 'b']
 
-const array3 = arrayMoveImmutable(input, -2, -3);
+const array3 = array.moveImmutable(input, -2, -3);
 console.log(array3);
 //=> ['b', 'a', 'c']
 ```
 
-- `arrayMoveMutable<T>(array: T[], fromIndex: number, toIndex: number): void`
+- `moveMutable<T>(array: T[], fromIndex: number, toIndex: number): void`
+
+- `moveToStart<T>(array: T[], predicate: (item: T) => boolean): T[]`
+
+移动元素到数组首位，不会修改原数组
+
+```js
+import { array } from '@d-matrix/utils';
+
+const list = [{ id: 1 }, { id: 2 }, { id: 3 }, { id: 4 }, { id: 5 }];
+const newList = array.moveToStart(list, (item) => item.id === 4);
+
+// [{ id: 4 }, { id: 1 }, { id: 2 }, { id: 3 }, { id: 5 }]
+```
 
 ## echarts