@d-matrix/utils 1.12.1 → 1.13.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/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/package.json

@@ -1,13 +1,14 @@
 {
   "name": "@d-matrix/utils",
   "sideEffects": false,
-  "version": "1.12.1",
+  "version": "1.13.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",

package/readme.md

@@ -150,7 +150,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 +171,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 +188,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>`