@ntnyq/utils 0.8.0 → 0.8.2

package/dist/index.d.ts

@@ -50,7 +50,6 @@ declare function isInteger(value: unknown): value is number;
 declare function isBigInt(value: unknown): value is bigint;
 declare function isBoolean(value: unknown): value is boolean;
 declare function isTruthy<T>(value: T | undefined): value is T;
-// eslint-disable-next-line @typescript-eslint/no-unsafe-function-type
 declare function isFunction(value: unknown): value is Function;
 declare function isArray(value: unknown): value is unknown[];
 declare function isEmptyArray(value: unknown): value is [];
@@ -183,7 +182,7 @@ declare function isElementVisibleInViewport(element: HTMLElement, targetWindow?:
 *
 * @returns boolean - true if the code is running in a browser
 */
-declare const isBrowser: () => boolean;
+declare function isBrowser(): boolean;
 //#endregion
 //#region src/file/removeExtension.d.ts
 /**
@@ -205,6 +204,10 @@ declare function escapeHTML(str: string): string;
 declare function unescapeHTML(str: string): string;
 //#endregion
 //#region src/misc/raf.d.ts
+/**
+* Gets the global root object.
+* @returns the global root object
+*/
 declare function getRoot(): Window | typeof globalThis;
 /**
 * Request animation frame
@@ -226,15 +229,35 @@ declare function cAF(id: number): void;
 * @file time utils
 * @module Time
 */
-declare const ONE_SECOND_MILLSECONDS: number;
-declare const ONE_MINUTE_MILLSECONDS: number;
-declare const ONE_HOUR_MILLSECONDS: number;
-declare const ONE_DAY_MILLSECONDS: number;
-declare const ONE_WEEK_MILLSECONDS: number;
+/**
+* Converts seconds to milliseconds.
+* @param count - The number of seconds.
+* @returns The equivalent number of milliseconds.
+*/
 declare function seconds(count: number): number;
+/**
+* Converts minutes to milliseconds.
+* @param count - The number of minutes.
+* @returns The equivalent number of milliseconds.
+*/
 declare function minutes(count: number): number;
+/**
+* Converts hours to milliseconds.
+* @param count - The number of hours.
+* @returns The equivalent number of milliseconds.
+*/
 declare function hours(count: number): number;
+/**
+* Converts days to milliseconds.
+* @param count - The number of days.
+* @returns The equivalent number of milliseconds.
+*/
 declare function days(count: number): number;
+/**
+* Converts weeks to milliseconds.
+* @param count - The number of weeks.
+* @returns The equivalent number of milliseconds.
+*/
 declare function weeks(count: number): number;
 //#endregion
 //#region src/misc/clamp.d.ts
@@ -293,6 +316,62 @@ declare function debounce<T extends ((...args: any[]) => undefined | void) | und
 */
 declare function warnOnce(message: string): void;
 //#endregion
+//#region src/misc/convertStorage.d.ts
+/**
+* @file src/misc/transform.ts
+*/
+/**
+* Storage unit conversion constants
+*/
+declare const STORAGE_UNITS: {
+  readonly BYTE: 1;
+  readonly KB: 1024;
+  readonly MB: 1048576;
+  readonly GB: 1073741824;
+  readonly TB: 1099511627776;
+};
+type StorageUnit = keyof typeof STORAGE_UNITS;
+/**
+* Converts storage units to bytes.
+* @param value - The size value.
+* @param fromUnit - The source unit (default: 'MB').
+* @returns The size in bytes.
+* @example
+* ```ts
+* convertToBytes(5, 'MB') // 5242880
+* convertToBytes(1, 'GB') // 1073741824
+* convertToBytes(512, 'KB') // 524288
+* ```
+*/
+declare function convertToBytes(value: number, fromUnit?: StorageUnit): number;
+/**
+* Converts bytes to specified storage unit.
+* @param bytes - The size in bytes.
+* @param toUnit - The target unit (default: 'MB').
+* @returns The size in the specified unit.
+* @example
+* ```ts
+* convertFromBytes(5242880, 'MB') // 5
+* convertFromBytes(1073741824, 'GB') // 1
+* convertFromBytes(524288, 'KB') // 512
+* ```
+*/
+declare function convertFromBytes(bytes: number, toUnit?: StorageUnit): number;
+/**
+* Converts between storage units.
+* @param value - The size value.
+* @param fromUnit - The source unit.
+* @param toUnit - The target unit.
+* @returns The converted size.
+* @example
+* ```ts
+* convertStorageUnit(1, 'GB', 'MB') // 1024
+* convertStorageUnit(2048, 'MB', 'GB') // 2
+* convertStorageUnit(1024, 'KB', 'MB') // 1
+* ```
+*/
+declare function convertStorageUnit(value: number, fromUnit: StorageUnit, toUnit: StorageUnit): number;
+//#endregion
 //#region src/array/at.d.ts
 /**
 * Get array item by index, negative for backward
@@ -747,4 +826,4 @@ declare const RE_LINE_COMMENT: RegExp;
 */
 declare const RE_BLOCK_COMMENT: RegExp;
 //#endregion
-export { AnyFn, Arrayable, Awaitable, Callable, CleanObjectOptions, Color, CreatePadStringOptions, DeepRequired, GetStringSimilarityOptions, InteropModuleDefault, JsonArray, JsonObject, JsonPrimitive, JsonValue, LiteralUnion, MayBe, Merge, NOOP, NonEmptyObject, NonEmptyString, Nullable, ONE_DAY_MILLSECONDS, ONE_HOUR_MILLSECONDS, ONE_MINUTE_MILLSECONDS, ONE_SECOND_MILLSECONDS, ONE_WEEK_MILLSECONDS, OpenExternalURLOptions, Overwrite, Prettify, PrettifyV2, Primitive, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, RamdomNumberOptions, ResolvedOptions, SPECIAL_CHAR, SortObjectOptions, ThrottleDebounceOptions, ToIntegerOptions, Whitespace, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, getRoot, getStringLength, getStringSimilarity, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isHTMLElement, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, removeFileExtension, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, toInteger, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+export { AnyFn, Arrayable, Awaitable, Callable, CleanObjectOptions, Color, CreatePadStringOptions, DeepRequired, GetStringSimilarityOptions, InteropModuleDefault, JsonArray, JsonObject, JsonPrimitive, JsonValue, LiteralUnion, MayBe, Merge, NOOP, NonEmptyObject, NonEmptyString, Nullable, OpenExternalURLOptions, Overwrite, Prettify, PrettifyV2, Primitive, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, RamdomNumberOptions, ResolvedOptions, SPECIAL_CHAR, STORAGE_UNITS, SortObjectOptions, StorageUnit, ThrottleDebounceOptions, ToIntegerOptions, Whitespace, at, cAF, chunk, clamp, cleanObject, convertFromBytes, convertStorageUnit, convertToBytes, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, getRoot, getStringLength, getStringSimilarity, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isHTMLElement, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, removeFileExtension, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, toInteger, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/dist/index.js

@@ -221,7 +221,9 @@ function isElementVisibleInViewport(element, targetWindow = window) {
 *
 * @returns boolean - true if the code is running in a browser
 */
-const isBrowser = () => typeof document !== "undefined";
+function isBrowser() {
+	return typeof document !== "undefined";
+}
 
 //#endregion
 //#region src/file/removeExtension.ts
@@ -273,17 +275,13 @@ function unescapeHTML(str) {
 
 //#endregion
 //#region src/misc/raf.ts
+/**
+* Gets the global root object.
+* @returns the global root object
+*/
 function getRoot() {
 	return isBrowser() ? window : globalThis;
 }
-let prev = Date.now();
-function mockRAF(fn) {
-	const curr = Date.now();
-	const ms = Math.max(0, 16 - (curr - prev));
-	const id = setTimeout(fn, ms);
-	prev = curr + ms;
-	return id;
-}
 /**
 * Request animation frame
 *
@@ -292,7 +290,7 @@ function mockRAF(fn) {
 */
 function rAF(fn) {
 	const root = getRoot();
-	const raf = root.requestAnimationFrame || mockRAF;
+	const raf = root.requestAnimationFrame;
 	return raf.call(root, fn);
 }
 /**
@@ -303,7 +301,7 @@ function rAF(fn) {
 */
 function cAF(id) {
 	const root = getRoot();
-	const caf = root.cancelAnimationFrame || root.clearTimeout;
+	const caf = root.cancelAnimationFrame;
 	return caf.call(root, id);
 }
 
@@ -313,25 +311,45 @@ function cAF(id) {
 * @file time utils
 * @module Time
 */
-const ONE_SECOND_MILLSECONDS = 1e3;
-const ONE_MINUTE_MILLSECONDS = 60 * 1e3;
-const ONE_HOUR_MILLSECONDS = 60 * 60 * 1e3;
-const ONE_DAY_MILLSECONDS = 24 * 60 * 60 * 1e3;
-const ONE_WEEK_MILLSECONDS = 7 * 24 * 60 * 60 * 1e3;
+/**
+* Converts seconds to milliseconds.
+* @param count - The number of seconds.
+* @returns The equivalent number of milliseconds.
+*/
 function seconds(count) {
-	return count * ONE_SECOND_MILLSECONDS;
+	return count * 1e3;
 }
+/**
+* Converts minutes to milliseconds.
+* @param count - The number of minutes.
+* @returns The equivalent number of milliseconds.
+*/
 function minutes(count) {
-	return count * ONE_MINUTE_MILLSECONDS;
+	return count * 60 * 1e3;
 }
+/**
+* Converts hours to milliseconds.
+* @param count - The number of hours.
+* @returns The equivalent number of milliseconds.
+*/
 function hours(count) {
-	return count * ONE_HOUR_MILLSECONDS;
+	return count * 60 * 60 * 1e3;
 }
+/**
+* Converts days to milliseconds.
+* @param count - The number of days.
+* @returns The equivalent number of milliseconds.
+*/
 function days(count) {
-	return count * ONE_DAY_MILLSECONDS;
+	return count * 24 * 60 * 60 * 1e3;
 }
+/**
+* Converts weeks to milliseconds.
+* @param count - The number of weeks.
+* @returns The equivalent number of milliseconds.
+*/
 function weeks(count) {
-	return count * ONE_WEEK_MILLSECONDS;
+	return count * 7 * 24 * 60 * 60 * 1e3;
 }
 
 //#endregion
@@ -435,6 +453,69 @@ function warnOnce(message) {
 	console.warn(message);
 }
 
+//#endregion
+//#region src/misc/convertStorage.ts
+/**
+* @file src/misc/transform.ts
+*/
+/**
+* Storage unit conversion constants
+*/
+const STORAGE_UNITS = {
+	BYTE: 1,
+	KB: 1024,
+	MB: 1024 * 1024,
+	GB: 1024 * 1024 * 1024,
+	TB: 1024 * 1024 * 1024 * 1024
+};
+/**
+* Converts storage units to bytes.
+* @param value - The size value.
+* @param fromUnit - The source unit (default: 'MB').
+* @returns The size in bytes.
+* @example
+* ```ts
+* convertToBytes(5, 'MB') // 5242880
+* convertToBytes(1, 'GB') // 1073741824
+* convertToBytes(512, 'KB') // 524288
+* ```
+*/
+function convertToBytes(value, fromUnit = "MB") {
+	return value * STORAGE_UNITS[fromUnit];
+}
+/**
+* Converts bytes to specified storage unit.
+* @param bytes - The size in bytes.
+* @param toUnit - The target unit (default: 'MB').
+* @returns The size in the specified unit.
+* @example
+* ```ts
+* convertFromBytes(5242880, 'MB') // 5
+* convertFromBytes(1073741824, 'GB') // 1
+* convertFromBytes(524288, 'KB') // 512
+* ```
+*/
+function convertFromBytes(bytes, toUnit = "MB") {
+	return bytes / STORAGE_UNITS[toUnit];
+}
+/**
+* Converts between storage units.
+* @param value - The size value.
+* @param fromUnit - The source unit.
+* @param toUnit - The target unit.
+* @returns The converted size.
+* @example
+* ```ts
+* convertStorageUnit(1, 'GB', 'MB') // 1024
+* convertStorageUnit(2048, 'MB', 'GB') // 2
+* convertStorageUnit(1024, 'KB', 'MB') // 1
+* ```
+*/
+function convertStorageUnit(value, fromUnit, toUnit) {
+	const bytes = convertToBytes(value, fromUnit);
+	return convertFromBytes(bytes, toUnit);
+}
+
 //#endregion
 //#region src/array/at.ts
 /**
@@ -628,7 +709,7 @@ function toInteger(value, options = {}) {
 		if (onError === "throwError") throw new TypeError(`Cannot convert NaN to an integer`);
 		return onError === "returnOriginal" ? value : defaultValue;
 	}
-	if (allowDecimal) result = Math.floor(numberValue);
+	if (allowDecimal) result = numberValue > 0 ? Math.floor(numberValue) : Math.ceil(numberValue);
 	else {
 		if (numberValue % 1 !== 0) {
 			if (onError === "throwError") throw new Error("Decimal values are not allowed");
@@ -1065,4 +1146,4 @@ const RE_LINE_COMMENT = /\/\/.*/;
 const RE_BLOCK_COMMENT = /\/\*[\s\S]*?\*\//g;
 
 //#endregion
-export { Color, NOOP, ONE_DAY_MILLSECONDS, ONE_HOUR_MILLSECONDS, ONE_MINUTE_MILLSECONDS, ONE_SECOND_MILLSECONDS, ONE_WEEK_MILLSECONDS, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, SPECIAL_CHAR, at, cAF, chunk, clamp, cleanObject, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, getRoot, getStringLength, getStringSimilarity, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isHTMLElement, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, removeFileExtension, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, toInteger, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };
+export { Color, NOOP, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, SPECIAL_CHAR, STORAGE_UNITS, at, cAF, chunk, clamp, cleanObject, convertFromBytes, convertStorageUnit, convertToBytes, createPadString, days, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, getRoot, getStringLength, getStringSimilarity, hasOwn, hours, interopDefault, intersect, isArray, isArrayEqual, isBigInt, isBoolean, isBrowser, isDeepEqual, isElementVisibleInViewport, isEmptyArray, isEmptyMap, isEmptyObject, isEmptySet, isEmptyString, isEmptyStringOrWhitespace, isError, isFunction, isHTMLElement, isInteger, isIterable, isMap, isNaN, isNativePromise, isNil, isNonEmptyArray, isNonEmptyString, isNull, isNullOrUndefined, isNumber, isNumbericString, isObject, isPromise, isRegExp, isSet, isString, isTruthy, isUndefined, isWhitespaceString, isZero, join, last, mergeArrayable, minutes, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, removeFileExtension, resolveSubOptions, scrollElementIntoView, seconds, slash, slugify, sortObject, throttle, toArray, toInteger, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce, weeks };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.8.0",
+  "version": "0.8.2",
   "description": "Common used utils.",
   "keywords": [
     "utils"
@@ -30,16 +30,16 @@
   ],
   "sideEffects": false,
   "devDependencies": {
-    "@ntnyq/eslint-config": "^5.0.0",
+    "@ntnyq/eslint-config": "^5.2.0",
     "@ntnyq/prettier-config": "^3.0.1",
-    "bumpp": "^10.2.0",
-    "eslint": "^9.30.1",
+    "bumpp": "^10.2.2",
+    "eslint": "^9.32.0",
     "husky": "^9.1.7",
     "nano-staged": "^0.8.0",
     "npm-run-all2": "^8.0.4",
     "prettier": "^3.6.2",
-    "tsdown": "^0.12.9",
-    "typescript": "^5.8.3",
+    "tsdown": "^0.13.1",
+    "typescript": "^5.9.2",
     "vitest": "^3.2.4"
   },
   "engines": {