delete fields from obj (#20)

* feat: checkPhoneNumber文档

* feat: deleteFieldsFromObj

* feat: deleteInvalidValue

* fix: tslint

* fix: package-lock.json

Author: urnotzane

docs/functions/checkPhoneNumber.md

@@ -0,0 +1,18 @@
+---
+title: checkPhoneNumber
+toc: menu
+---
+
+# checkPhoneNumber
+检查手机号是否合法。
+```typescript
+import { checkPhoneNumber } from '@mlz/doraemon';
+
+checkPhoneNumber('13222222222'); // true
+checkPhoneNumber(13222222222); // true
+checkPhoneNumber('12222222222'); // false
+checkPhoneNumber('23222222222'); // false
+checkPhoneNumber('1322222222'); // false
+checkPhoneNumber(null); // false
+checkPhoneNumber(undefined); // true
+```

docs/functions/deleteFieldsFromObj.md

@@ -0,0 +1,19 @@
+---
+title: deleteFieldsFromObj
+toc: menu
+---
+
+# deleteFieldsFromObj
+删除目标对象的目标字段。
+```typescript
+import { deleteFieldsFromObj } from '@mlz/doraemon';
+
+deleteFieldsFromObj([1], [0]); // {}
+deleteFieldsFromObj({}, ['a']); // {}
+deleteFieldsFromObj({
+    a: 1,
+    b: '2',
+    c: null,
+    d: undefined,
+  }, ['a', 'c']); // { b: '2', d: undefined }
+```

docs/functions/deleteInvalidValue.md

@@ -0,0 +1,15 @@
+---
+title: deleteInvalidValue
+toc: menu
+---
+
+# deleteInvalidValue
+删除目标对象的无效值如`null`|`undefined`。
+```typescript
+import { deleteInvalidValue } from '@mlz/doraemon';
+
+deleteFieldsFromObj({}); // {}
+deleteFieldsFromObj([]); // []
+deleteFieldsFromObj(['a']); // ['a']
+deleteFieldsFromObj({ a: NaN, b: 2, c: null, d: undefined }); // { b: 2 }
+```

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "@mlz/doraemon",
-  "version": "0.6.0",
+  "version": "0.7.0",
   "description": "常用工具函数集合，释放你的Ctrl C、Ctrl V",
   "main": "lib/index.js",
   "module": "es/index.js",
@@ -67,8 +67,6 @@
     "@mlz/lint": "^1.1.10",
     "@types/jest": "^26.0.0",
     "@types/lodash": "^4.14.157",
-    "copyfiles": "^2.3.0",
-    "cross-env": "^7.0.2",
     "dumi": "^1.0.8",
     "eslint": "^7.2.0",
     "father-build": "^1.17.2",

package.json

@@ -1,5 +1,6 @@
 import * as _ from 'lodash';
 
+/** 检查手机号是否合法 */
 export const checkPhoneNumber = (phoneNumber:string|number) => {
   if (_.isNull(phoneNumber) || _.isUndefined(phoneNumber)) {
     return false;

src/checkPhoneNumber.ts

@@ -0,0 +1,22 @@
+import { IObject } from './global';
+import * as _ from 'lodash';
+
+/**
+ * @description 从目标对象删除传入的字段并返回删除后的object
+ * @param target 目标对象
+ * @param keys 要删除的字段的key的数组
+ */
+export const deleteFieldsFromObj = <T = IObject>(target:T, keys:(keyof T)[]):T|{} => {
+  if (!_.isPlainObject(target)) {
+    return {};
+  }
+  if (!_.isArray(keys)) {
+    return {};
+  }
+  keys.forEach((key) => {
+    delete target[key];
+  });
+  return target;
+};
+
+export default deleteFieldsFromObj;

src/deleteFieldsFromObj.ts

@@ -0,0 +1,18 @@
+import { IObject } from "./global";
+import { isPlainObject, isNull, isUndefined } from "lodash";
+
+/**
+ * @description 删除对象里无效值如`null`|`undefined`
+ */
+export const deleteInvalidValue = <T = IObject>(target:T) => {
+  if (isPlainObject(target)) {
+    for (const [key, value] of Object.entries(target)) {
+      if (isNull(value) || isUndefined(value) || isNaN(value)) {
+        delete target[key];
+      }
+    }
+  }
+  return target;
+};
+
+export default deleteInvalidValue;

src/deleteInvalidValue.ts

@@ -0,0 +1,31 @@
+import { deleteFieldsFromObj } from '../src/deleteFieldsFromObj';
+
+describe('deleteFieldsFromObj', () => {
+  const ex = {
+    a: 1,
+    b: '2',
+    c: null,
+    d: undefined,
+  };
+  it('targe=[1, 2], key=[0]', () => {
+    expect(deleteFieldsFromObj([1, 2], [0])).toEqual({});
+  });
+  it('null', () => {
+    expect(deleteFieldsFromObj(null, [0])).toEqual({});
+  });
+  it('undefined', () => {
+    expect(deleteFieldsFromObj(undefined, [0])).toEqual({});
+  });
+  it('Empty object', () => {
+    expect(deleteFieldsFromObj({}, ['a'] as any)).toEqual({});
+  });
+  it('Keys are not an array', () => {
+    expect(deleteFieldsFromObj(ex, { a: 1 } as any)).toEqual({});
+  });
+  it('An object', () => {
+    expect(deleteFieldsFromObj(ex, ['a', 'c'])).toEqual({
+      b: '2',
+      d: undefined,
+    });
+  });
+});

test/deleteFieldsFromObj.test.ts

@@ -0,0 +1,25 @@
+import { deleteInvalidValue } from '../src/deleteInvalidValue';
+
+describe('deleteInvalidValue', () => {
+  it('null', () => {
+    expect(deleteInvalidValue(null)).toBeNull();
+  });
+  it('undefined', () => {
+    expect(deleteInvalidValue(undefined)).toBeUndefined();
+  });
+  it('Empty object', () => {
+    expect(deleteInvalidValue({})).toEqual({});
+  });
+  it('has NaN', () => {
+    expect(deleteInvalidValue({ a: NaN, b: 2 })).toEqual({ b: 2 });
+  });
+  it('has null', () => {
+    expect(deleteInvalidValue({ a: null, b: 2 })).toEqual({ b: 2 });
+  });
+  it('has undefined', () => {
+    expect(deleteInvalidValue({ a: undefined, b: 2 })).toEqual({ b: 2 });
+  });
+  it('normal', () => {
+    expect(deleteInvalidValue({ a: 1, b: 2 })).toEqual({ a: 1, b: 2 });
+  });
+});