Support BigInt (#66)

fisker · web-flow · commit 014edf29c5df · 2024-01-18T17:08:15.000+07:00
diff --git a/index.d.ts b/index.d.ts
@@ -117,7 +117,7 @@ prettyMilliseconds(new Date(2014, 0, 1, 10, 40) - new Date(2014, 0, 1, 10, 5))
 ```
 */
 export default function prettyMilliseconds(
-	milliseconds: number,
+	milliseconds: number | bigint,
 	options?: Options
 ): string;
 
diff --git a/index.js b/index.js
@@ -4,10 +4,12 @@ const isZero = value => value === 0 || value === 0n;
 const pluralize = (word, count) => (count === 1 || count === 1n) ? word : `${word}s`;
 
 const SECOND_ROUNDING_EPSILON = 0.000_000_1;
+const ONE_DAY_IN_MILLISECONDS = 24n * 60n * 60n * 1000n;
 
 export default function prettyMilliseconds(milliseconds, options) {
-	if (!Number.isFinite(milliseconds)) {
-		throw new TypeError('Expected a finite number');
+	const isBigInt = typeof milliseconds === 'bigint';
+	if (!isBigInt && !Number.isFinite(milliseconds)) {
+		throw new TypeError('Expected a finite number or bigint');
 	}
 
 	options = {...options};
@@ -58,27 +60,34 @@ export default function prettyMilliseconds(milliseconds, options) {
 	};
 
 	const parsed = parseMilliseconds(milliseconds);
+	const days = BigInt(parsed.days);
 
-	add(BigInt(parsed.days) / 365n, 'year', 'y');
-	add(parsed.days % 365, 'day', 'd');
-	add(parsed.hours, 'hour', 'h');
-	add(parsed.minutes, 'minute', 'm');
+	add(days / 365n, 'year', 'y');
+	add(days % 365n, 'day', 'd');
+	add(Number(parsed.hours), 'hour', 'h');
+	add(Number(parsed.minutes), 'minute', 'm');
 
 	if (
 		options.separateMilliseconds
 		|| options.formatSubMilliseconds
 		|| (!options.colonNotation && milliseconds < 1000)
 	) {
-		add(parsed.seconds, 'second', 's');
+		const seconds = Number(parsed.seconds);
+		const milliseconds = Number(parsed.milliseconds);
+		const microseconds = Number(parsed.microseconds);
+		const nanoseconds = Number(parsed.nanoseconds);
+
+		add(seconds, 'second', 's');
+
 		if (options.formatSubMilliseconds) {
-			add(parsed.milliseconds, 'millisecond', 'ms');
-			add(parsed.microseconds, 'microsecond', 'µs');
-			add(parsed.nanoseconds, 'nanosecond', 'ns');
+			add(milliseconds, 'millisecond', 'ms');
+			add(microseconds, 'microsecond', 'µs');
+			add(nanoseconds, 'nanosecond', 'ns');
 		} else {
 			const millisecondsAndBelow
-				= parsed.milliseconds
-				+ (parsed.microseconds / 1000)
-				+ (parsed.nanoseconds / 1e6);
+				= milliseconds
+				+ (microseconds / 1000)
+				+ (nanoseconds / 1e6);
 
 			const millisecondsDecimalDigits
 				= typeof options.millisecondsDecimalDigits === 'number'
@@ -101,7 +110,10 @@ export default function prettyMilliseconds(milliseconds, options) {
 			);
 		}
 	} else {
-		const seconds = (milliseconds / 1000) % 60;
+		const seconds = (
+			(isBigInt ? Number(milliseconds % ONE_DAY_IN_MILLISECONDS) : milliseconds)
+			/ 1000
+		) % 60;
 		const secondsDecimalDigits
 			= typeof options.secondsDecimalDigits === 'number'
 				? options.secondsDecimalDigits
diff --git a/index.test-d.ts b/index.test-d.ts
@@ -2,6 +2,7 @@ import {expectType} from 'tsd';
 import prettyMilliseconds from './index.js';
 
 expectType<string>(prettyMilliseconds(1_335_669_000));
+expectType<string>(prettyMilliseconds(1_335_669_000n));
 expectType<string>(prettyMilliseconds(1_335_669_000, {secondsDecimalDigits: 1}));
 expectType<string>(
 	prettyMilliseconds(1_335_669_000, {millisecondsDecimalDigits: 2}),
diff --git a/readme.md b/readme.md
@@ -16,6 +16,9 @@ import prettyMilliseconds from 'pretty-ms';
 prettyMilliseconds(1337000000);
 //=> '15d 11h 23m 20s'
 
+prettyMilliseconds(1337000000n);
+//=> '15d 11h 23m 20s'
+
 prettyMilliseconds(1337);
 //=> '1.3s'
 
@@ -49,7 +52,7 @@ prettyMilliseconds(new Date(2014, 0, 1, 10, 40) - new Date(2014, 0, 1, 10, 5))
 
 #### milliseconds
 
-Type: `number`
+Type: `number | bigint`
 
 Milliseconds to humanize.
 
diff --git a/test.js b/test.js
