Update docs

sindresorhus · Jan 18, 2024 · 6b6ccb3 · 6b6ccb3
1 parent 1f28fdf
commit 6b6ccb3
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 2 deletions.
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.test-d.ts b/index.test-d.ts
@@ -21,3 +21,24 @@ expectType<string>(
 expectType<string>(
 	prettyMilliseconds(1_335_669_000, {colonNotation: true}),
 );
+
+expectType<string>(prettyMilliseconds(1_335_669_000n));
+expectType<string>(prettyMilliseconds(1_335_669_000n, {secondsDecimalDigits: 1}));
+expectType<string>(
+	prettyMilliseconds(1_335_669_000n, {millisecondsDecimalDigits: 2}),
+);
+expectType<string>(
+	prettyMilliseconds(1_335_669_000n, {keepDecimalsOnWholeSeconds: true}),
+);
+expectType<string>(prettyMilliseconds(1337n, {compact: true}));
+expectType<string>(prettyMilliseconds(1_335_669_000n, {unitCount: 2}));
+expectType<string>(prettyMilliseconds(1_335_669_000n, {verbose: true}));
+expectType<string>(
+	prettyMilliseconds(1_335_669_000n, {separateMilliseconds: true}),
+);
+expectType<string>(
+	prettyMilliseconds(1_335_669_000n, {formatSubMilliseconds: true}),
+);
+expectType<string>(
+	prettyMilliseconds(1_335_669_000n, {colonNotation: true}),
+);
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.