@d-matrix/utils 1.10.0 → 1.11.0

package/dist/date.d.ts

@@ -1,3 +1,7 @@
+export interface RecentYearOption {
+    label: string;
+    value: number;
+}
 /**
  * Generates an array of numbers representing a range of years between the start year and the end year.
  *
@@ -5,16 +9,20 @@
  * @param {number} end - the ending year of the range (defaults to the current year)
  * @return {number[]} an array of numbers representing the range of years
  */
-export declare const rangeOfYears: (start: number, end?: number) => number[];
-export interface RecentYearOption {
-    label: string;
-    value: number;
-}
+export declare function rangeOfYears(start: number, end?: number): number[];
+export declare type GetRecentYearsOptions = {
+    startYear?: number;
+    recentYears?: number;
+    endYear?: number;
+    suffix?: string;
+};
 /**
- * 获取最近n年, 从大到小
- * @param recentYears 最近几年
- * @param type 控制返回值类型
- * @param suffix 后缀，默认为'年'
+ * 获取n年, 从大到小
+ * @param options
  */
-export declare function getRecentYears(recentYears: number, type: 'number[]'): number[];
-export declare function getRecentYears(recentYears: number, type: 'object[]'): RecentYearOption[];
+export declare function getYears(options: GetRecentYearsOptions & {
+    type: 'number[]';
+}): number[];
+export declare function getYears(options: GetRecentYearsOptions & {
+    type: 'object[]';
+}): RecentYearOption[];

package/dist/date.js

@@ -5,24 +5,43 @@
  * @param {number} end - the ending year of the range (defaults to the current year)
  * @return {number[]} an array of numbers representing the range of years
  */
-export const rangeOfYears = (start, end = new Date().getFullYear()) => Array(end - start + 1)
-    .fill(start)
-    .map((year, index) => year + index);
-export function getRecentYears(recentYears, type, suffix = '年') {
-    const thisYear = new Date().getFullYear();
+export function rangeOfYears(start, end = new Date().getFullYear()) {
+    return Array(end - start + 1)
+        .fill(start)
+        .map((year, index) => year + index);
+}
+export function getYears(options) {
+    const { recentYears = 0, startYear, endYear, suffix = '年', type } = options;
+    const endY = endYear ? endYear : new Date().getFullYear();
+    let ranges = recentYears;
+    if (typeof startYear === 'number') {
+        // 包含startYear
+        ranges = endY - startYear + 1;
+        if (ranges <= 0) {
+            if (process.env.NODE_ENV === 'development') {
+                if (endYear === undefined) {
+                    console.error('startYear不能大于当前年份');
+                }
+                else if (typeof endYear === 'number') {
+                    console.error('endYear不能小于startYear');
+                }
+            }
+            return [];
+        }
+    }
     if (type === 'number[]') {
         const result = [];
-        for (let i = 0; i < recentYears; i++) {
-            result.push(thisYear - i);
+        for (let i = 0; i < ranges; i++) {
+            result.push(endY - i);
         }
         return result;
     }
     if (type === 'object[]') {
         const result = [];
-        for (let i = 0; i < recentYears; i++) {
+        for (let i = 0; i < ranges; i++) {
             result.push({
-                value: thisYear - i,
-                label: `${thisYear - i}${suffix}`,
+                value: endY - i,
+                label: `${endY - i}${suffix}`,
             });
         }
         return result;

package/package.json

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

package/readme.md

@@ -146,27 +146,34 @@ dom.strip('测试<em>高亮</em>测试'); // '测试高亮测试'
 - `getRecentYears()`
 
 ```ts
-export function getRecentYears(recentYears: number, type: 'number[]'): number[];
-export function getRecentYears(recentYears: number, type: 'object[]'): RecentYearOption[];
-export function getRecentYears(recentYears: number, type: 'number[]' | 'object[]', suffix = '年'): number[] | RecentYearOption[]
+export type GetRecentYearsOptions = {
+  // 开始年份
+  startYear?: number;
+  // 最近几年
+  recentYears?: number;
+  // 截止年份
+  endYear?: number;
+  // 后缀，默认为'年'
+  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[]
 ```
 
-获取最近n年
+获取n年，`type`传`number[]`，返回`[2023, 2022, 2021]`数字数组；`type`传`object[]`，返回如下的对象数组
 
-```ts
-import { date } from '@d-matrix/utils';
-
-getRecentYears(5, 'number[]'); // [2024, 2023, 2022, 2021, 2020]
-getRecentYears(5, 'object[]');
-// [
-//   { value: 2024, label: '2024年' },
-//   { value: 2023, label: '2023年' },
-//   { value: 2022, label: '2022年' },
-//   { value: 2021, label: '2021年' },
-//   { value: 2020, label: '2020年' },
-// ]
+```sh
+[
+  { value: 2023, label: '2023年' },
+  { value: 2022, label: '2022年' },
+  { value: 2021, label: '2021年' },
+]
 ```
 
+更多用法，见[测试用例](./tests/date.cy.ts)
+
 ### types
 
 - `WithOptional<T, K extends keyof T>`