@gateweb/react-utils 1.0.0 → 1.1.0

package/dist/cjs/index.d.ts

@@ -604,6 +604,24 @@ declare const formatAmount: (num: number) => string;
  * formatString('123456', 1, 4) // '1****6'
  */
 declare const formatStarMask: (str: string, n: number, m: number) => string;
+/**
+ * format file size to human readable string
+ *
+ * it will convert bytes to KB, MB, GB, TB, PB, EB, ZB, YB
+ *
+ * @param bytes file size in bytes
+ * @param decimals number of decimal places (default is 2)
+ *
+ * @example
+ *
+ * ```js
+ * formatBytes(0) // 0 Bytes
+ * formatBytes(1024) // 1 KB
+ * formatBytes(1024, 2) // 1.00 KB
+ * formatBytes(1024 * 1024) // 1 MB
+ * ```
+ */
+declare const formatBytes: (bytes: number, decimals?: number) => string;
 
 /**
  * 檢查稅務編號是否符合正確的編號規則。
@@ -688,4 +706,4 @@ declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefin
  */
 declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
 
-export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };
+export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };

package/dist/cjs/index.js

@@ -765,6 +765,39 @@ message) {
  *
  * formatString('123456', 1, 4) // '1****6'
  */ const formatStarMask = (str, n, m)=>str.slice(0, n) + '*'.repeat(m - n + 1) + str.slice(m + 1);
+/**
+ * format file size to human readable string
+ *
+ * it will convert bytes to KB, MB, GB, TB, PB, EB, ZB, YB
+ *
+ * @param bytes file size in bytes
+ * @param decimals number of decimal places (default is 2)
+ *
+ * @example
+ *
+ * ```js
+ * formatBytes(0) // 0 Bytes
+ * formatBytes(1024) // 1 KB
+ * formatBytes(1024, 2) // 1.00 KB
+ * formatBytes(1024 * 1024) // 1 MB
+ * ```
+ */ const formatBytes = (bytes, decimals = 0)=>{
+    if (bytes === 0) return '0 Bytes';
+    const k = 1024;
+    const sizes = [
+        'Bytes',
+        'KB',
+        'MB',
+        'GB',
+        'TB',
+        'PB',
+        'EB',
+        'ZB',
+        'YB'
+    ];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    return `${(bytes / k ** i).toFixed(decimals)} ${sizes[i]}`;
+};
 
 /**
  * Wait for a given amount of time
@@ -786,6 +819,7 @@ exports.debounce = debounce;
 exports.extractEnumLikeObject = extractEnumLikeObject;
 exports.fakeApi = fakeApi;
 exports.formatAmount = formatAmount;
+exports.formatBytes = formatBytes;
 exports.formatStarMask = formatStarMask;
 exports.generatePeriodArray = generatePeriodArray;
 exports.getCurrentPeriod = getCurrentPeriod;

package/dist/es/index.d.mts

@@ -604,6 +604,24 @@ declare const formatAmount: (num: number) => string;
  * formatString('123456', 1, 4) // '1****6'
  */
 declare const formatStarMask: (str: string, n: number, m: number) => string;
+/**
+ * format file size to human readable string
+ *
+ * it will convert bytes to KB, MB, GB, TB, PB, EB, ZB, YB
+ *
+ * @param bytes file size in bytes
+ * @param decimals number of decimal places (default is 2)
+ *
+ * @example
+ *
+ * ```js
+ * formatBytes(0) // 0 Bytes
+ * formatBytes(1024) // 1 KB
+ * formatBytes(1024, 2) // 1.00 KB
+ * formatBytes(1024 * 1024) // 1 MB
+ * ```
+ */
+declare const formatBytes: (bytes: number, decimals?: number) => string;
 
 /**
  * 檢查稅務編號是否符合正確的編號規則。
@@ -688,4 +706,4 @@ declare const getLocalStorage: <T>(key: string, deCode?: boolean) => T | undefin
  */
 declare const setLocalStorage: (key: string, value: Record<string, any>, enCode?: boolean) => void;
 
-export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };
+export { type TCountdownActions, adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, downloadFile, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getLocalStorage, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, setLocalStorage, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, useCountdown, validTaxId, validateDateString, validateFileType, wait };

package/dist/es/index.mjs

@@ -759,6 +759,39 @@ message) {
  *
  * formatString('123456', 1, 4) // '1****6'
  */ const formatStarMask = (str, n, m)=>str.slice(0, n) + '*'.repeat(m - n + 1) + str.slice(m + 1);
+/**
+ * format file size to human readable string
+ *
+ * it will convert bytes to KB, MB, GB, TB, PB, EB, ZB, YB
+ *
+ * @param bytes file size in bytes
+ * @param decimals number of decimal places (default is 2)
+ *
+ * @example
+ *
+ * ```js
+ * formatBytes(0) // 0 Bytes
+ * formatBytes(1024) // 1 KB
+ * formatBytes(1024, 2) // 1.00 KB
+ * formatBytes(1024 * 1024) // 1 MB
+ * ```
+ */ const formatBytes = (bytes, decimals = 0)=>{
+    if (bytes === 0) return '0 Bytes';
+    const k = 1024;
+    const sizes = [
+        'Bytes',
+        'KB',
+        'MB',
+        'GB',
+        'TB',
+        'PB',
+        'EB',
+        'ZB',
+        'YB'
+    ];
+    const i = Math.floor(Math.log(bytes) / Math.log(k));
+    return `${(bytes / k ** i).toFixed(decimals)} ${sizes[i]}`;
+};
 
 /**
  * Wait for a given amount of time
@@ -766,4 +799,4 @@ message) {
  */ const wait = (ms)=>{
 };
 
-export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, extractEnumLikeObject, fakeApi, formatAmount, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, validTaxId, validateDateString, validateFileType, wait };
+export { adToRocEra, camelCase2PascalCase, camelCase2SnakeCase, camelString2PascalString, camelString2SnakeString, createEnumLikeObject, debounce, extractEnumLikeObject, fakeApi, formatAmount, formatBytes, formatStarMask, generatePeriodArray, getCurrentPeriod, getMimeType, invariant, isChinese, isDateString, isDateTimeString, isEmail, isEnglish, isNonZeroStart, isNumber, isNumberAtLeastN, isNumberN, isNumberNM, isServer, isTWMobile, isTWPhone, isTimeString, omit, omitByValue, pascalCase2CamelCase, pascalCase2SnakeCase, pascalString2CamelString, pascalString2SnakeString, rocEraToAd, snakeCase2CamelCase, snakeCase2PascalCase, snakeString2CamelString, snakeString2PascalString, throttle, validTaxId, validateDateString, validateFileType, wait };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@gateweb/react-utils",
-  "version": "1.0.0",
+  "version": "1.1.0",
   "description": "React Utils for GateWeb",
   "homepage": "https://github.com/GatewebSolutions/react-utils",
   "files": [