react-util-tools 1.0.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (24) hide show
  1. package/README.md +254 -0
  2. package/dist/index.cjs +943 -0
  3. package/dist/index.d.cts +154 -0
  4. package/dist/index.d.ts +154 -0
  5. package/dist/index.js +852 -0
  6. package/package.json +50 -0
  7. package/src/address/README.md +196 -0
  8. package/src/address/index.ts +41 -0
  9. package/src/date/README.md +539 -0
  10. package/src/date/index.ts +330 -0
  11. package/src/date/utc/README.md +779 -0
  12. package/src/date/utc/index.ts +374 -0
  13. package/src/decimal/README.md +425 -0
  14. package/src/decimal/index.ts +9 -0
  15. package/src/decimal/utils/README.md +474 -0
  16. package/src/decimal/utils/index.ts +244 -0
  17. package/src/device/README.md +441 -0
  18. package/src/device/index.ts +214 -0
  19. package/src/format/README.md +335 -0
  20. package/src/format/index.ts +189 -0
  21. package/src/index.ts +107 -0
  22. package/src/throttle/README.md +152 -0
  23. package/src/throttle/index.ts +83 -0
  24. package/tsconfig.json +28 -0
package/dist/index.d.cts ADDED
@@ -0,0 +1,154 @@
1
+ import Decimal from 'decimal.js';
2
+ export { default as Decimal, Decimal as DecimalType } from 'decimal.js';
3
+
4
+ declare function throttleFn<T extends (...args: any[]) => any>(fn: T, wait?: number, options?: {
5
+ leading?: boolean;
6
+ trailing?: boolean;
7
+ }): (...args: Parameters<T>) => void;
8
+ declare function debounceFn<T extends (...args: any[]) => any>(fn: T, wait?: number, immediate?: boolean): (...args: Parameters<T>) => void;
9
+
10
+ declare function getQueryParam(key: string, url?: string): string | null;
11
+ declare function getAllQueryParams(url?: string): Record<string, string>;
12
+ declare function getQueryParamAll(key: string, url?: string): string[];
13
+
14
+ declare function getOS(): string;
15
+ declare function getBrowser(): string;
16
+ declare function getBrowserEngine(): string;
17
+ declare function isMobile(): boolean;
18
+ declare function isTablet(): boolean;
19
+ declare function isDesktop(): boolean;
20
+ declare function getDeviceType(): 'mobile' | 'tablet' | 'desktop';
21
+ declare function isWeChat(): boolean;
22
+ declare function isIOS(): boolean;
23
+ declare function isAndroid(): boolean;
24
+ declare function getBrowserVersion(): string;
25
+ declare function getDevicePixelRatio(): number;
26
+ declare function getScreenResolution(): {
27
+ width: number;
28
+ height: number;
29
+ };
30
+ declare function getViewportSize(): {
31
+ width: number;
32
+ height: number;
33
+ };
34
+ declare function isTouchDevice(): boolean;
35
+ declare function getDeviceInfo(): {
36
+ os: string;
37
+ browser: string;
38
+ browserVersion: string;
39
+ browserEngine: string;
40
+ deviceType: "mobile" | "tablet" | "desktop";
41
+ isMobile: boolean;
42
+ isTablet: boolean;
43
+ isDesktop: boolean;
44
+ isIOS: boolean;
45
+ isAndroid: boolean;
46
+ isWeChat: boolean;
47
+ isTouchDevice: boolean;
48
+ devicePixelRatio: number;
49
+ screenResolution: {
50
+ width: number;
51
+ height: number;
52
+ };
53
+ viewportSize: {
54
+ width: number;
55
+ height: number;
56
+ };
57
+ userAgent: string;
58
+ };
59
+
60
+ declare function formatMoney(amount: number | string, options?: {
61
+ decimals?: number;
62
+ symbol?: string;
63
+ separator?: string;
64
+ decimalPoint?: string;
65
+ }): string;
66
+ declare function parseMoney(formattedAmount: string): number;
67
+ declare function formatNumber(amount: number | string, decimals?: number): string;
68
+ declare function formatMoneyToChinese(amount: number | string): string;
69
+ declare function formatPercent(value: number, options?: {
70
+ decimals?: number;
71
+ multiply?: boolean;
72
+ }): string;
73
+
74
+ declare function formatDate(date: Date | number | string, formatStr?: string): string;
75
+ declare function formatDateOnly(date: Date | number | string): string;
76
+ declare function formatTimeOnly(date: Date | number | string): string;
77
+ declare function formatRelativeTime(date: Date | number | string, locale?: 'zh' | 'en'): string;
78
+ declare function parseDate(dateStr: string, formatStr?: string): Date;
79
+ declare function isValidDate(date: Date | number | string): boolean;
80
+ declare function getDaysDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
81
+ declare function getHoursDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
82
+ declare function getMinutesDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
83
+ declare function addDaysToDate(date: Date | number | string, amount: number): Date;
84
+ declare function subDaysFromDate(date: Date | number | string, amount: number): Date;
85
+ declare function addMonthsToDate(date: Date | number | string, amount: number): Date;
86
+ declare function subMonthsFromDate(date: Date | number | string, amount: number): Date;
87
+ declare function getStartOfDay(date: Date | number | string): Date;
88
+ declare function getEndOfDay(date: Date | number | string): Date;
89
+ declare function getStartOfWeek(date: Date | number | string): Date;
90
+ declare function getEndOfWeek(date: Date | number | string): Date;
91
+ declare function getStartOfMonth(date: Date | number | string): Date;
92
+ declare function getEndOfMonth(date: Date | number | string): Date;
93
+ declare function getStartOfYear(date: Date | number | string): Date;
94
+ declare function getEndOfYear(date: Date | number | string): Date;
95
+ declare function isBeforeDate(date: Date | number | string, dateToCompare: Date | number | string): boolean;
96
+ declare function isAfterDate(date: Date | number | string, dateToCompare: Date | number | string): boolean;
97
+ declare function isSameDayDate(dateLeft: Date | number | string, dateRight: Date | number | string): boolean;
98
+ declare function getTimestamp(): number;
99
+ declare function getTimestampInSeconds(): number;
100
+
101
+ declare function toUTC(date: Date | number | string): Date;
102
+ declare function fromUTC(utcDate: Date | number | string): Date;
103
+ declare function formatUTC(date: Date | number | string, formatStr?: string): string;
104
+ declare function formatUTCDateOnly(date: Date | number | string): string;
105
+ declare function formatUTCTimeOnly(date: Date | number | string): string;
106
+ declare function toISOString(date: Date | number | string): string;
107
+ declare function getUTCNow(): Date;
108
+ declare function getUTCTimestamp(): number;
109
+ declare function getUTCTimestampInSeconds(): number;
110
+ declare function getUTCStartOfDay(date: Date | number | string): Date;
111
+ declare function getUTCEndOfDay(date: Date | number | string): Date;
112
+ declare function getUTCStartOfMonth(date: Date | number | string): Date;
113
+ declare function getUTCEndOfMonth(date: Date | number | string): Date;
114
+ declare function addDaysUTC(date: Date | number | string, amount: number): Date;
115
+ declare function subDaysUTC(date: Date | number | string, amount: number): Date;
116
+ declare function addMonthsUTC(date: Date | number | string, amount: number): Date;
117
+ declare function subMonthsUTC(date: Date | number | string, amount: number): Date;
118
+ declare function getUTCDaysDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
119
+ declare function getUTCHoursDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
120
+ declare function getUTCMinutesDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
121
+ declare function getTimezoneOffset(): number;
122
+ declare function getTimezoneOffsetHours(): number;
123
+ declare function getUTCYearStartTimestamp(year?: number): number;
124
+ declare function getUTCYearEndTimestamp(year?: number): number;
125
+ declare function getUTCYearStart(year?: number): Date;
126
+ declare function getUTCYearEnd(year?: number): Date;
127
+ declare function getUTCWeeksInYear(year?: number): number;
128
+ declare function getUTCWeekStart(year: number, week: number): Date;
129
+ declare function getUTCWeekEnd(year: number, week: number): Date;
130
+ declare function getUTCAllWeeksInYear(year?: number): Array<{
131
+ week: number;
132
+ start: Date;
133
+ end: Date;
134
+ startTimestamp: number;
135
+ endTimestamp: number;
136
+ }>;
137
+ declare function getUTCWeekNumber(date: Date | number | string): number;
138
+
139
+ declare function add(a: number | string | Decimal, b: number | string | Decimal): number;
140
+ declare function subtract(a: number | string | Decimal, b: number | string | Decimal): number;
141
+ declare function multiply(a: number | string | Decimal, b: number | string | Decimal): number;
142
+ declare function divide(a: number | string | Decimal, b: number | string | Decimal): number;
143
+ declare function equals(a: number | string | Decimal, b: number | string | Decimal): boolean;
144
+ declare function greaterThan(a: number | string | Decimal, b: number | string | Decimal): boolean;
145
+ declare function lessThan(a: number | string | Decimal, b: number | string | Decimal): boolean;
146
+ declare function greaterThanOrEqual(a: number | string | Decimal, b: number | string | Decimal): boolean;
147
+ declare function lessThanOrEqual(a: number | string | Decimal, b: number | string | Decimal): boolean;
148
+ declare function round(value: number | string | Decimal, decimalPlaces?: number): number;
149
+ declare function ceil(value: number | string | Decimal, decimalPlaces?: number): number;
150
+ declare function floor(value: number | string | Decimal, decimalPlaces?: number): number;
151
+ declare function abs(value: number | string | Decimal): number;
152
+ declare function negate(value: number | string | Decimal): number;
153
+
154
+ export { abs, add, addDaysToDate, addDaysUTC, addMonthsToDate, addMonthsUTC, ceil, debounceFn as debounce, divide, equals, floor, formatDate, formatDateOnly, formatMoney, formatMoneyToChinese, formatNumber, formatPercent, formatRelativeTime, formatTimeOnly, formatUTC, formatUTCDateOnly, formatUTCTimeOnly, fromUTC, getAllQueryParams, getBrowser, getBrowserEngine, getBrowserVersion, getDaysDiff, getDeviceInfo, getDevicePixelRatio, getDeviceType, getEndOfDay, getEndOfMonth, getEndOfWeek, getEndOfYear, getHoursDiff, getMinutesDiff, getOS, getQueryParam, getQueryParamAll, getScreenResolution, getStartOfDay, getStartOfMonth, getStartOfWeek, getStartOfYear, getTimestamp, getTimestampInSeconds, getTimezoneOffset, getTimezoneOffsetHours, getUTCAllWeeksInYear, getUTCDaysDiff, getUTCEndOfDay, getUTCEndOfMonth, getUTCHoursDiff, getUTCMinutesDiff, getUTCNow, getUTCStartOfDay, getUTCStartOfMonth, getUTCTimestamp, getUTCTimestampInSeconds, getUTCWeekEnd, getUTCWeekNumber, getUTCWeekStart, getUTCWeeksInYear, getUTCYearEnd, getUTCYearEndTimestamp, getUTCYearStart, getUTCYearStartTimestamp, getViewportSize, greaterThan, greaterThanOrEqual, isAfterDate, isAndroid, isBeforeDate, isDesktop, isIOS, isMobile, isSameDayDate, isTablet, isTouchDevice, isValidDate, isWeChat, lessThan, lessThanOrEqual, multiply, negate, parseDate, parseMoney, round, subDaysFromDate, subDaysUTC, subMonthsFromDate, subMonthsUTC, subtract, throttleFn as throttle, toISOString, toUTC };
package/dist/index.d.ts ADDED
@@ -0,0 +1,154 @@
1
+ import Decimal from 'decimal.js';
2
+ export { default as Decimal, Decimal as DecimalType } from 'decimal.js';
3
+
4
+ declare function throttleFn<T extends (...args: any[]) => any>(fn: T, wait?: number, options?: {
5
+ leading?: boolean;
6
+ trailing?: boolean;
7
+ }): (...args: Parameters<T>) => void;
8
+ declare function debounceFn<T extends (...args: any[]) => any>(fn: T, wait?: number, immediate?: boolean): (...args: Parameters<T>) => void;
9
+
10
+ declare function getQueryParam(key: string, url?: string): string | null;
11
+ declare function getAllQueryParams(url?: string): Record<string, string>;
12
+ declare function getQueryParamAll(key: string, url?: string): string[];
13
+
14
+ declare function getOS(): string;
15
+ declare function getBrowser(): string;
16
+ declare function getBrowserEngine(): string;
17
+ declare function isMobile(): boolean;
18
+ declare function isTablet(): boolean;
19
+ declare function isDesktop(): boolean;
20
+ declare function getDeviceType(): 'mobile' | 'tablet' | 'desktop';
21
+ declare function isWeChat(): boolean;
22
+ declare function isIOS(): boolean;
23
+ declare function isAndroid(): boolean;
24
+ declare function getBrowserVersion(): string;
25
+ declare function getDevicePixelRatio(): number;
26
+ declare function getScreenResolution(): {
27
+ width: number;
28
+ height: number;
29
+ };
30
+ declare function getViewportSize(): {
31
+ width: number;
32
+ height: number;
33
+ };
34
+ declare function isTouchDevice(): boolean;
35
+ declare function getDeviceInfo(): {
36
+ os: string;
37
+ browser: string;
38
+ browserVersion: string;
39
+ browserEngine: string;
40
+ deviceType: "mobile" | "tablet" | "desktop";
41
+ isMobile: boolean;
42
+ isTablet: boolean;
43
+ isDesktop: boolean;
44
+ isIOS: boolean;
45
+ isAndroid: boolean;
46
+ isWeChat: boolean;
47
+ isTouchDevice: boolean;
48
+ devicePixelRatio: number;
49
+ screenResolution: {
50
+ width: number;
51
+ height: number;
52
+ };
53
+ viewportSize: {
54
+ width: number;
55
+ height: number;
56
+ };
57
+ userAgent: string;
58
+ };
59
+
60
+ declare function formatMoney(amount: number | string, options?: {
61
+ decimals?: number;
62
+ symbol?: string;
63
+ separator?: string;
64
+ decimalPoint?: string;
65
+ }): string;
66
+ declare function parseMoney(formattedAmount: string): number;
67
+ declare function formatNumber(amount: number | string, decimals?: number): string;
68
+ declare function formatMoneyToChinese(amount: number | string): string;
69
+ declare function formatPercent(value: number, options?: {
70
+ decimals?: number;
71
+ multiply?: boolean;
72
+ }): string;
73
+
74
+ declare function formatDate(date: Date | number | string, formatStr?: string): string;
75
+ declare function formatDateOnly(date: Date | number | string): string;
76
+ declare function formatTimeOnly(date: Date | number | string): string;
77
+ declare function formatRelativeTime(date: Date | number | string, locale?: 'zh' | 'en'): string;
78
+ declare function parseDate(dateStr: string, formatStr?: string): Date;
79
+ declare function isValidDate(date: Date | number | string): boolean;
80
+ declare function getDaysDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
81
+ declare function getHoursDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
82
+ declare function getMinutesDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
83
+ declare function addDaysToDate(date: Date | number | string, amount: number): Date;
84
+ declare function subDaysFromDate(date: Date | number | string, amount: number): Date;
85
+ declare function addMonthsToDate(date: Date | number | string, amount: number): Date;
86
+ declare function subMonthsFromDate(date: Date | number | string, amount: number): Date;
87
+ declare function getStartOfDay(date: Date | number | string): Date;
88
+ declare function getEndOfDay(date: Date | number | string): Date;
89
+ declare function getStartOfWeek(date: Date | number | string): Date;
90
+ declare function getEndOfWeek(date: Date | number | string): Date;
91
+ declare function getStartOfMonth(date: Date | number | string): Date;
92
+ declare function getEndOfMonth(date: Date | number | string): Date;
93
+ declare function getStartOfYear(date: Date | number | string): Date;
94
+ declare function getEndOfYear(date: Date | number | string): Date;
95
+ declare function isBeforeDate(date: Date | number | string, dateToCompare: Date | number | string): boolean;
96
+ declare function isAfterDate(date: Date | number | string, dateToCompare: Date | number | string): boolean;
97
+ declare function isSameDayDate(dateLeft: Date | number | string, dateRight: Date | number | string): boolean;
98
+ declare function getTimestamp(): number;
99
+ declare function getTimestampInSeconds(): number;
100
+
101
+ declare function toUTC(date: Date | number | string): Date;
102
+ declare function fromUTC(utcDate: Date | number | string): Date;
103
+ declare function formatUTC(date: Date | number | string, formatStr?: string): string;
104
+ declare function formatUTCDateOnly(date: Date | number | string): string;
105
+ declare function formatUTCTimeOnly(date: Date | number | string): string;
106
+ declare function toISOString(date: Date | number | string): string;
107
+ declare function getUTCNow(): Date;
108
+ declare function getUTCTimestamp(): number;
109
+ declare function getUTCTimestampInSeconds(): number;
110
+ declare function getUTCStartOfDay(date: Date | number | string): Date;
111
+ declare function getUTCEndOfDay(date: Date | number | string): Date;
112
+ declare function getUTCStartOfMonth(date: Date | number | string): Date;
113
+ declare function getUTCEndOfMonth(date: Date | number | string): Date;
114
+ declare function addDaysUTC(date: Date | number | string, amount: number): Date;
115
+ declare function subDaysUTC(date: Date | number | string, amount: number): Date;
116
+ declare function addMonthsUTC(date: Date | number | string, amount: number): Date;
117
+ declare function subMonthsUTC(date: Date | number | string, amount: number): Date;
118
+ declare function getUTCDaysDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
119
+ declare function getUTCHoursDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
120
+ declare function getUTCMinutesDiff(dateLeft: Date | number | string, dateRight: Date | number | string): number;
121
+ declare function getTimezoneOffset(): number;
122
+ declare function getTimezoneOffsetHours(): number;
123
+ declare function getUTCYearStartTimestamp(year?: number): number;
124
+ declare function getUTCYearEndTimestamp(year?: number): number;
125
+ declare function getUTCYearStart(year?: number): Date;
126
+ declare function getUTCYearEnd(year?: number): Date;
127
+ declare function getUTCWeeksInYear(year?: number): number;
128
+ declare function getUTCWeekStart(year: number, week: number): Date;
129
+ declare function getUTCWeekEnd(year: number, week: number): Date;
130
+ declare function getUTCAllWeeksInYear(year?: number): Array<{
131
+ week: number;
132
+ start: Date;
133
+ end: Date;
134
+ startTimestamp: number;
135
+ endTimestamp: number;
136
+ }>;
137
+ declare function getUTCWeekNumber(date: Date | number | string): number;
138
+
139
+ declare function add(a: number | string | Decimal, b: number | string | Decimal): number;
140
+ declare function subtract(a: number | string | Decimal, b: number | string | Decimal): number;
141
+ declare function multiply(a: number | string | Decimal, b: number | string | Decimal): number;
142
+ declare function divide(a: number | string | Decimal, b: number | string | Decimal): number;
143
+ declare function equals(a: number | string | Decimal, b: number | string | Decimal): boolean;
144
+ declare function greaterThan(a: number | string | Decimal, b: number | string | Decimal): boolean;
145
+ declare function lessThan(a: number | string | Decimal, b: number | string | Decimal): boolean;
146
+ declare function greaterThanOrEqual(a: number | string | Decimal, b: number | string | Decimal): boolean;
147
+ declare function lessThanOrEqual(a: number | string | Decimal, b: number | string | Decimal): boolean;
148
+ declare function round(value: number | string | Decimal, decimalPlaces?: number): number;
149
+ declare function ceil(value: number | string | Decimal, decimalPlaces?: number): number;
150
+ declare function floor(value: number | string | Decimal, decimalPlaces?: number): number;
151
+ declare function abs(value: number | string | Decimal): number;
152
+ declare function negate(value: number | string | Decimal): number;
153
+
154
+ export { abs, add, addDaysToDate, addDaysUTC, addMonthsToDate, addMonthsUTC, ceil, debounceFn as debounce, divide, equals, floor, formatDate, formatDateOnly, formatMoney, formatMoneyToChinese, formatNumber, formatPercent, formatRelativeTime, formatTimeOnly, formatUTC, formatUTCDateOnly, formatUTCTimeOnly, fromUTC, getAllQueryParams, getBrowser, getBrowserEngine, getBrowserVersion, getDaysDiff, getDeviceInfo, getDevicePixelRatio, getDeviceType, getEndOfDay, getEndOfMonth, getEndOfWeek, getEndOfYear, getHoursDiff, getMinutesDiff, getOS, getQueryParam, getQueryParamAll, getScreenResolution, getStartOfDay, getStartOfMonth, getStartOfWeek, getStartOfYear, getTimestamp, getTimestampInSeconds, getTimezoneOffset, getTimezoneOffsetHours, getUTCAllWeeksInYear, getUTCDaysDiff, getUTCEndOfDay, getUTCEndOfMonth, getUTCHoursDiff, getUTCMinutesDiff, getUTCNow, getUTCStartOfDay, getUTCStartOfMonth, getUTCTimestamp, getUTCTimestampInSeconds, getUTCWeekEnd, getUTCWeekNumber, getUTCWeekStart, getUTCWeeksInYear, getUTCYearEnd, getUTCYearEndTimestamp, getUTCYearStart, getUTCYearStartTimestamp, getViewportSize, greaterThan, greaterThanOrEqual, isAfterDate, isAndroid, isBeforeDate, isDesktop, isIOS, isMobile, isSameDayDate, isTablet, isTouchDevice, isValidDate, isWeChat, lessThan, lessThanOrEqual, multiply, negate, parseDate, parseMoney, round, subDaysFromDate, subDaysUTC, subMonthsFromDate, subMonthsUTC, subtract, throttleFn as throttle, toISOString, toUTC };