@ntnyq/utils 0.8.2 → 0.9.0

package/dist/index.d.ts

@@ -224,42 +224,6 @@ declare function rAF(fn: FrameRequestCallback): number;
 */
 declare function cAF(id: number): void;
 //#endregion
-//#region src/misc/time.d.ts
-/**
-* @file time utils
-* @module Time
-*/
-/**
-* 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
 /**
 * Clamps a number between a minimum and maximum value
@@ -316,9 +280,68 @@ declare function debounce<T extends ((...args: any[]) => undefined | void) | und
 */
 declare function warnOnce(message: string): void;
 //#endregion
+//#region src/misc/convertTime.d.ts
+/**
+* @file time utils
+* @module Time
+*/
+/**
+* Time unit conversion constants (in milliseconds)
+*/
+declare const TIME_UNITS: {
+  readonly MILLISECOND: 1;
+  readonly SECOND: 1000;
+  readonly MINUTE: 60000;
+  readonly HOUR: 3600000;
+  readonly DAY: 86400000;
+  readonly WEEK: 604800000;
+};
+type TimeUnit = keyof typeof TIME_UNITS;
+/**
+* Converts time units to milliseconds.
+* @param value - The time value.
+* @param fromUnit - The source unit (default: 'SECOND').
+* @returns The time in milliseconds.
+* @example
+* ```ts
+* convertToMilliseconds(5, 'SECOND') // 5000
+* convertToMilliseconds(2, 'MINUTE') // 120000
+* convertToMilliseconds(1, 'HOUR') // 3600000
+* ```
+*/
+declare function convertToMilliseconds(value: number, fromUnit?: TimeUnit): number;
+/**
+* Converts milliseconds to specified time unit.
+* @param milliseconds - The time in milliseconds.
+* @param toUnit - The target unit (default: 'SECOND').
+* @returns The time in the specified unit.
+* @example
+* ```ts
+* convertFromMilliseconds(5000, 'SECOND') // 5
+* convertFromMilliseconds(120000, 'MINUTE') // 2
+* convertFromMilliseconds(3600000, 'HOUR') // 1
+* ```
+*/
+declare function convertFromMilliseconds(milliseconds: number, toUnit?: TimeUnit): number;
+/**
+* Converts between time units.
+* @param value - The time value.
+* @param fromUnit - The source unit.
+* @param toUnit - The target unit.
+* @returns The converted time.
+* @example
+* ```ts
+* convertTimeUnit(1, 'HOUR', 'MINUTE') // 60
+* convertTimeUnit(120, 'SECOND', 'MINUTE') // 2
+* convertTimeUnit(2, 'WEEK', 'DAY') // 14
+* ```
+*/
+declare function convertTimeUnit(value: number, fromUnit: TimeUnit, toUnit: TimeUnit): number;
+//#endregion
 //#region src/misc/convertStorage.d.ts
 /**
-* @file src/misc/transform.ts
+* @file storage utils
+* @module Storage
 */
 /**
 * Storage unit conversion constants
@@ -826,4 +849,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, 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 };
+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, TIME_UNITS, ThrottleDebounceOptions, TimeUnit, ToIntegerOptions, Whitespace, at, cAF, chunk, clamp, cleanObject, convertFromBytes, convertFromMilliseconds, convertStorageUnit, convertTimeUnit, convertToBytes, convertToMilliseconds, createPadString, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, getRoot, getStringLength, getStringSimilarity, hasOwn, 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, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, removeFileExtension, resolveSubOptions, scrollElementIntoView, slash, slugify, sortObject, throttle, toArray, toInteger, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce };

package/dist/index.js

@@ -305,53 +305,6 @@ function cAF(id) {
 	return caf.call(root, id);
 }
 
-//#endregion
-//#region src/misc/time.ts
-/**
-* @file time utils
-* @module Time
-*/
-/**
-* Converts seconds to milliseconds.
-* @param count - The number of seconds.
-* @returns The equivalent number of milliseconds.
-*/
-function seconds(count) {
-	return count * 1e3;
-}
-/**
-* Converts minutes to milliseconds.
-* @param count - The number of minutes.
-* @returns The equivalent number of milliseconds.
-*/
-function minutes(count) {
-	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 * 60 * 60 * 1e3;
-}
-/**
-* Converts days to milliseconds.
-* @param count - The number of days.
-* @returns The equivalent number of milliseconds.
-*/
-function days(count) {
-	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 * 7 * 24 * 60 * 60 * 1e3;
-}
-
 //#endregion
 //#region src/misc/clamp.ts
 /**
@@ -453,10 +406,76 @@ function warnOnce(message) {
 	console.warn(message);
 }
 
+//#endregion
+//#region src/misc/convertTime.ts
+/**
+* @file time utils
+* @module Time
+*/
+/**
+* Time unit conversion constants (in milliseconds)
+*/
+const TIME_UNITS = {
+	MILLISECOND: 1,
+	SECOND: 1e3,
+	MINUTE: 60 * 1e3,
+	HOUR: 3600 * 1e3,
+	DAY: 1440 * 60 * 1e3,
+	WEEK: 10080 * 60 * 1e3
+};
+/**
+* Converts time units to milliseconds.
+* @param value - The time value.
+* @param fromUnit - The source unit (default: 'SECOND').
+* @returns The time in milliseconds.
+* @example
+* ```ts
+* convertToMilliseconds(5, 'SECOND') // 5000
+* convertToMilliseconds(2, 'MINUTE') // 120000
+* convertToMilliseconds(1, 'HOUR') // 3600000
+* ```
+*/
+function convertToMilliseconds(value, fromUnit = "SECOND") {
+	return value * TIME_UNITS[fromUnit];
+}
+/**
+* Converts milliseconds to specified time unit.
+* @param milliseconds - The time in milliseconds.
+* @param toUnit - The target unit (default: 'SECOND').
+* @returns The time in the specified unit.
+* @example
+* ```ts
+* convertFromMilliseconds(5000, 'SECOND') // 5
+* convertFromMilliseconds(120000, 'MINUTE') // 2
+* convertFromMilliseconds(3600000, 'HOUR') // 1
+* ```
+*/
+function convertFromMilliseconds(milliseconds, toUnit = "SECOND") {
+	return milliseconds / TIME_UNITS[toUnit];
+}
+/**
+* Converts between time units.
+* @param value - The time value.
+* @param fromUnit - The source unit.
+* @param toUnit - The target unit.
+* @returns The converted time.
+* @example
+* ```ts
+* convertTimeUnit(1, 'HOUR', 'MINUTE') // 60
+* convertTimeUnit(120, 'SECOND', 'MINUTE') // 2
+* convertTimeUnit(2, 'WEEK', 'DAY') // 14
+* ```
+*/
+function convertTimeUnit(value, fromUnit, toUnit) {
+	const milliseconds = convertToMilliseconds(value, fromUnit);
+	return convertFromMilliseconds(milliseconds, toUnit);
+}
+
 //#endregion
 //#region src/misc/convertStorage.ts
 /**
-* @file src/misc/transform.ts
+* @file storage utils
+* @module Storage
 */
 /**
 * Storage unit conversion constants
@@ -1146,4 +1165,4 @@ const RE_LINE_COMMENT = /\/\/.*/;
 const RE_BLOCK_COMMENT = /\/\*[\s\S]*?\*\//g;
 
 //#endregion
-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 };
+export { Color, NOOP, RE_BLOCK_COMMENT, RE_COMMENTS, RE_LINE_COMMENT, SPECIAL_CHAR, STORAGE_UNITS, TIME_UNITS, at, cAF, chunk, clamp, cleanObject, convertFromBytes, convertFromMilliseconds, convertStorageUnit, convertTimeUnit, convertToBytes, convertToMilliseconds, createPadString, debounce, enhance, ensurePrefix, ensureSuffix, escapeHTML, flattenArrayable, getObjectType, getRoot, getStringLength, getStringSimilarity, hasOwn, 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, noop, omit, once, openExternalURL, pick, rAF, randomHexColor, randomNumber, randomRGBAColor, randomRGBColor, randomString, removeFileExtension, resolveSubOptions, scrollElementIntoView, slash, slugify, sortObject, throttle, toArray, toInteger, unescapeHTML, unindent, unique, uniqueBy, waitFor, warnOnce };

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@ntnyq/utils",
   "type": "module",
-  "version": "0.8.2",
+  "version": "0.9.0",
   "description": "Common used utils.",
   "keywords": [
     "utils"