@d-matrix/utils 1.12.1 → 1.14.0

package/dist/date.d.ts

@@ -1,7 +1,4 @@
-export interface RecentYearOption {
-    label: string;
-    value: number;
-}
+import { i18n } from './i18n';
 /**
  * Generates an array of numbers representing a range of years between the start year and the end year.
  *
@@ -10,7 +7,15 @@ export interface RecentYearOption {
  * @return {number[]} an array of numbers representing the range of years
  */
 export declare function rangeOfYears(start: number, end?: number): number[];
-export declare type GetRecentYearsOptions = {
+export declare enum YearOptionKind {
+    Numbers = 0,
+    Objects = 1
+}
+export interface YearOption {
+    label: string;
+    value: number;
+}
+export declare type GetYearsOptions = {
     startYear?: number;
     recentYears?: number;
     endYear?: number;
@@ -20,9 +25,10 @@ export declare type GetRecentYearsOptions = {
  * 获取n年, 从大到小
  * @param options
  */
-export declare function getYears(options: GetRecentYearsOptions & {
-    type: 'number[]';
+export declare function getYears(options: GetYearsOptions & {
+    type: YearOptionKind.Numbers;
 }): number[];
-export declare function getYears(options: GetRecentYearsOptions & {
-    type: 'object[]';
-}): RecentYearOption[];
+export declare function getYears(options: GetYearsOptions & {
+    type: YearOptionKind.Objects;
+}): YearOption[];
+export declare const dayOfWeek: (num: number, lang?: keyof typeof i18n) => string;

package/dist/date.js

@@ -1,3 +1,4 @@
+import { i18n } from './i18n';
 /**
  * Generates an array of numbers representing a range of years between the start year and the end year.
  *
@@ -10,6 +11,11 @@ export function rangeOfYears(start, end = new Date().getFullYear()) {
         .fill(start)
         .map((year, index) => year + index);
 }
+export var YearOptionKind;
+(function (YearOptionKind) {
+    YearOptionKind[YearOptionKind["Numbers"] = 0] = "Numbers";
+    YearOptionKind[YearOptionKind["Objects"] = 1] = "Objects";
+})(YearOptionKind || (YearOptionKind = {}));
 export function getYears(options) {
     const { recentYears = 0, startYear, endYear, suffix = '年', type } = options;
     const endY = endYear ? endYear : new Date().getFullYear();
@@ -29,14 +35,14 @@ export function getYears(options) {
             return [];
         }
     }
-    if (type === 'number[]') {
+    if (type === YearOptionKind.Numbers) {
         const result = [];
         for (let i = 0; i < ranges; i++) {
             result.push(endY - i);
         }
         return result;
     }
-    if (type === 'object[]') {
+    if (type === YearOptionKind.Objects) {
         const result = [];
         for (let i = 0; i < ranges; i++) {
             result.push({
@@ -46,5 +52,11 @@ export function getYears(options) {
         }
         return result;
     }
-    throw new Error('type must be "number[]" or "object[]"');
+    throw new Error('type must be enum: YearOptionKind.Numbers or YearOptionKind.Objects');
 }
+export const dayOfWeek = (num, lang = 'zh') => {
+    if (!Number.isInteger(num)) {
+        throw new Error('请输入一个整数');
+    }
+    return i18n[lang].dayOfWeek[num % 7];
+};

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))) {
+        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/i18n.d.ts

@@ -0,0 +1,10 @@
+export declare const i18n: {
+    readonly en: {
+        readonly months: readonly ["January", "February", "March", "April", "May", "June", "July", "August", "September", "October", "November", "December"];
+        readonly dayOfWeek: readonly ["Sun", "Mon", "Tue", "Wed", "Thu", "Fri", "Sat"];
+    };
+    readonly zh: {
+        readonly months: readonly ["一月", "二月", "三月", "四月", "五月", "六月", "七月", "八月", "九月", "十月", "十一月", "十二月"];
+        readonly dayOfWeek: readonly ["日", "一", "二", "三", "四", "五", "六"];
+    };
+};

package/dist/i18n.js

@@ -0,0 +1,12 @@
+export const i18n = {
+    en: {
+        // English
+        months: ['January', 'February', 'March', 'April', 'May', 'June', 'July', 'August', 'September', 'October', 'November', 'December'],
+        dayOfWeek: ['Sun', 'Mon', 'Tue', 'Wed', 'Thu', 'Fri', 'Sat'],
+    },
+    zh: {
+        // Simplified Chinese (简体中文)
+        months: ['一月', '二月', '三月', '四月', '五月', '六月', '七月', '八月', '九月', '十月', '十一月', '十二月'],
+        dayOfWeek: ['日', '一', '二', '三', '四', '五', '六'],
+    },
+};

package/dist/index.d.ts

@@ -8,3 +8,4 @@ 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';

package/dist/index.js

@@ -8,3 +8,4 @@ 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';

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,13 +1,14 @@
 {
   "name": "@d-matrix/utils",
   "sideEffects": false,
-  "version": "1.12.1",
+  "version": "1.14.0",
   "description": "A dozen of utils for Front-End Development",
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
     "prebuild": "npm run clean",
     "postpublish": "echo \"wait for 3 seconds, then sync cnpm\" && npm run wait3s && npm run cnpm:sync",
+    "prepublishOnly": "npm run build",
     "clean": "rimraf dist",
     "cy:open": "cypress open",
     "cy:component": "cypress run --component --spec",
@@ -53,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,7 @@ A dozen of utils for Front-End Development
 - [support](#support)
 - [timer](#timer)
 - [operator](#operator)
+- [decimal](#decimal)
 
 ### clipboard
 
@@ -125,6 +126,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`
@@ -150,7 +187,17 @@ dom.strip('测试<em>高亮</em>测试'); // '测试高亮测试'
 - `getYears()`
 
 ```ts
-export type GetRecentYearsOptions = {
+export interface YearOption {
+  label: string;
+  value: number;
+}
+
+export enum YearOptionKind {
+  Numbers,
+  Objects,
+}
+
+export type GetYearsOptions = {
   // 开始年份
   startYear?: number;
   // 最近几年
@@ -161,12 +208,12 @@ export type GetRecentYearsOptions = {
   suffix?: string;
 };
 
-export function getYears(options: GetRecentYearsOptions & { type: 'number[]' }): number[];
-export function getYears(options: GetRecentYearsOptions & { type: 'object[]' }): RecentYearOption[];
-export function getYears(options: GetRecentYearsOptions & { type: 'object[]' | 'number[]' }): number[] | RecentYearOption[]
+export function getYears(options: GetYearsOptions & { type: YearOptionKind.Numbers }): number[];
+export function getYears(options: GetYearsOptions & { type: YearOptionKind.Objects }): YearOption[];
+export function getYears(options: GetYearsOptions & { type: YearOptionKind }): number[] | YearOption[]
 ```
 
-获取n年，`type`传`number[]`，返回`[2023, 2022, 2021]`数字数组；`type`传`object[]`，返回如下的对象数组
+获取n年，`type`传`YearOptionKind.Numbers`，返回`[2023, 2022, 2021]`数字数组；`type`传`YearOptionKind.Objects`，返回如下的对象数组
 
 ```sh
 [
@@ -178,6 +225,14 @@ export function getYears(options: GetRecentYearsOptions & { type: 'object[]' | '
 
 更多用法，见[测试用例](./tests/date.cy.ts)
 
+- `dayOfWeek(num: number, lang: keyof typeof i18n = 'zh'): string`
+
+返回星期几, `lang`仅支持`zh`和`en`, `num`必须为正整数,否则报错
+
+```js
+dayOfWeek(0) // "日"
+```
+
 ### types
 
 - `WithOptional<T, K extends keyof T>`
@@ -187,6 +242,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[]`
@@ -303,6 +402,23 @@ trueTypeOf(null); // null
 trueTypeOf(undefined); // undefined
 ```
 
+- `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;
+  }[];
+};
+```
+
 ## 测试
 
 运行全部组件测试
@@ -337,6 +453,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)