@d-matrix/utils 1.13.0 → 1.15.0

package/dist/decimal.d.ts

@@ -0,0 +1,17 @@
+export declare type FormatOptions = {
+    decimalPlaces?: number | false;
+    suffix?: string;
+    prefix?: string;
+    defaultValue?: string;
+    operation?: {
+        operator: 'add' | 'sub' | 'mul' | 'div' | 'toDecimalPlaces';
+        value: number;
+    }[];
+};
+/**
+ * 格式化数字，默认保留3位小数，可添加前缀，后缀，默认值为'--'
+ * @param value
+ * @param options
+ * @returns
+ */
+export declare function format(value: number | string | undefined | null, options?: FormatOptions): string;

package/dist/decimal.js

@@ -0,0 +1,23 @@
+import Decimal from 'decimal.js-light';
+/**
+ * 格式化数字，默认保留3位小数，可添加前缀，后缀，默认值为'--'
+ * @param value
+ * @param options
+ * @returns
+ */
+export function format(value, options) {
+    const { decimalPlaces = 3, suffix = '', defaultValue = '--', prefix = '', operation } = options !== null && options !== void 0 ? options : {};
+    if (value === null || value === undefined || isNaN(Number(value)) || value === '') {
+        return defaultValue;
+    }
+    let decimalValue = new Decimal(value);
+    if (Array.isArray(operation) && operation.length > 0) {
+        operation.forEach((item) => {
+            decimalValue = decimalValue[item.operator](item.value);
+        });
+    }
+    if (decimalPlaces == false) {
+        return prefix + decimalValue.toString() + suffix;
+    }
+    return prefix + decimalValue.toFixed(decimalPlaces) + suffix;
+}

package/dist/index.d.ts

@@ -8,3 +8,5 @@ export * as file from './file';
 export * as support from './support';
 export * as timer from './timer';
 export * as operator from './operator';
+export * as decimal from './decimal';
+export * as object from './object';

package/dist/index.js

@@ -8,3 +8,5 @@ export * as file from './file';
 export * as support from './support';
 export * as timer from './timer';
 export * as operator from './operator';
+export * as decimal from './decimal';
+export * as object from './object';

package/dist/object.d.ts

@@ -0,0 +1,6 @@
+export declare const ZeroValues: ({} | null | undefined)[];
+/**
+ * 移除零值的键
+ * 默认的零值是：undefined、null、空字符串, NaN, [], {}
+ */
+export declare const removeZeroValueKeys: <T extends Record<string, any>>(obj: T, zeroValues?: ({} | null | undefined)[]) => T;

package/dist/object.js

@@ -0,0 +1,21 @@
+import isEqual from 'react-fast-compare';
+export const ZeroValues = [undefined, null, '', NaN, [], {}];
+/**
+ * 移除零值的键
+ * 默认的零值是：undefined、null、空字符串, NaN, [], {}
+ */
+// TODO: improve TS type
+export const removeZeroValueKeys = (obj, zeroValues = ZeroValues) => {
+    if (!Array.isArray(zeroValues)) {
+        throw new Error('zeroValues must be an array');
+    }
+    const r = {};
+    for (const key in obj) {
+        const value = obj[key];
+        const shouldRemove = zeroValues.some((v) => isEqual(v, value));
+        if (shouldRemove)
+            continue;
+        r[key] = value;
+    }
+    return r;
+};

package/dist/react/types.d.ts

@@ -0,0 +1,2 @@
+import type { ForwardRefExoticComponent } from 'react';
+export declare type InferRef<T> = T extends ForwardRefExoticComponent<infer Ref> ? Ref extends React.RefAttributes<infer RefElement> ? RefElement : never : never;

package/dist/react/types.js

@@ -0,0 +1 @@
+export {};

package/dist/types.d.ts

@@ -5,3 +5,11 @@ export declare type ExcludePickPartial<T, K extends keyof T> = Partial<Omit<T, K
 export declare type Undefinable<T> = {
     [K in keyof T]: T[K] | undefined;
 };
+/** 获取对象中的方法名称，返回union type */
+export declare type FunctionPropertyNames<T> = {
+    [P in keyof T]-?: T[P] extends Function ? P : never;
+}[keyof T];
+/** 获取对象中非函数属性名称，返回union type */
+export declare type NonFunctionPropertyNames<T> = {
+    [P in keyof T]-?: T[P] extends Function ? never : P;
+}[keyof T];

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@d-matrix/utils",
   "sideEffects": false,
-  "version": "1.13.0",
+  "version": "1.15.0",
   "description": "A dozen of utils for Front-End Development",
   "main": "dist/index.js",
   "scripts": {
@@ -54,6 +54,7 @@
     "vite": "^4.5.2"
   },
   "dependencies": {
+    "decimal.js-light": "^2.5.1",
     "react-fast-compare": "^3.2.2"
   }
 }

package/readme.md

@@ -17,6 +17,8 @@ A dozen of utils for Front-End Development
 - [support](#support)
 - [timer](#timer)
 - [operator](#operator)
+- [decimal](#decimal)
+- [object](#object)
 
 ### clipboard
 
@@ -125,6 +127,42 @@ import { react } from '@d-matrix/utils';
 
 深比较`deps`。返回`ref`，`ref.current`是一个自增数字，每次`deps`变化，`ref.current`加`1`。用法见[测试](./tests/react.cy.tsx)
 
+- `InferRef<T>`
+
+推导子组件的`ref`类型，适用于组件没有导出其`ref`类型的场景, 更多用法见[测试](./tests/react-types.tsx)
+
+```tsx
+interface ChildRefProps {
+  prop1: () => void;
+  prop2: () => void;
+}
+
+interface ChildProps {
+  otherProp: string;
+}
+
+const Child = React.forwardRef<ChildRefProps, ChildProps>((props, ref) => {
+  React.useImperativeHandle(
+    ref,
+    () => ({
+      prop1() {},
+      prop2() {},
+    }),
+    [],
+  );
+
+  return null;
+});
+
+type InferredChildRef = InferRef<typeof Child>;  // 等价于ChildRefProps
+
+const Parent = () => {
+  const childRef = React.useRef<InferredChildRef>(null);
+
+  return <Child ref={childRef} otherProp="a" />;
+};
+```
+
 ### dom
 
 - `scrollToTop(element: Element | null | undefined): void`
@@ -205,6 +243,50 @@ type A = { a: number; b: number; c: number; };
 type T0 = WithOptional<A, 'b' | 'c'>;  // { a: number; b?: number; c?: number }
 ```
 
+- `FunctionPropertyNames<T>`
+
+获取对象中的方法名称，返回union type
+
+```ts
+class A {
+  add() {}
+  minus() {}
+  div() {}
+  public result: number = 0;
+}
+type T0 = FunctionPropertyNames<A>; // 'add' | 'minus' | 'div'
+
+const t1 = {
+  add() {},
+  minus() {},
+  div() {},
+  result: 0,
+};
+type T1 =  FunctionPropertyNames<typeof t1>; // 'add' | 'minus' | 'div'
+```
+
+- `NonFunctionPropertyNames<T>`
+
+获取对象中非函数属性名称，返回union type
+
+```ts
+class A {
+  add() {}
+  minus() {}
+  div() {}
+  public result: number = 0;
+}
+type T0 = FunctionPropertyNames<A>; // 'result'
+
+const t1 = {
+  add() {},
+  minus() {},
+  div() {},
+  result: 0,
+};
+type T1 =  FunctionPropertyNames<typeof t1>; // 'result'
+```
+
 ### algorithm
 
 - `moveMulti<T extends unknown>(arr: T[], indexes: number[], start: number): T[]`
@@ -321,6 +403,36 @@ trueTypeOf(null); // null
 trueTypeOf(undefined); // undefined
 ```
 
+## decimal
+
+- `format(value: number | string | undefined | null, options?: FormatOptions): string`
+
+格式化数字，默认保留3位小数，可添加前缀，后缀，默认值为'--'，用法见[测试](./tests//decimal.cy.ts)
+
+```ts
+type FormatOptions = {
+  decimalPlaces?: number | false;
+  suffix?: string;
+  prefix?: string;
+  defaultValue?: string;
+  operation?: {
+    operator: 'add' | 'sub' | 'mul' | 'div' | 'toDecimalPlaces';
+    value: number;
+  }[];
+};
+```
+
+## object
+
+- `removeZeroValueKeys = <T extends Record<string, any>>(obj: T, zeroValues = ZeroValues): T`
+
+移除零值的键, 默认的零值是：`undefined`、`null`, `''`, `NaN`, `[]`, `{}`
+
+```ts
+removeZeroValueKeys({ a: '', b: 'abc', c: undefined, d: null, e: NaN, f: -1, g: [], h: {} })
+// { b: 'abc', f: -1 }
+```
+
 ## 测试
 
 运行全部组件测试
@@ -355,6 +467,12 @@ npm build
 npm publish --access public
 ```
 
+网络原因导致连接registry服务器超时,可指定proxy
+
+```bash
+npm --proxy http://127.0.0.1:7890 publish
+```
+
 镜像站查询版本与手动同步:
 
 [npm镜像站](https://npmmirror.com/package/@d-matrix/utils)