@sindresorhus/to-milliseconds - npm Package Compare versions

Comparing version 1.1.0 to 1.2.0

index.d.ts

@@ -1,14 +0,41 @@
-export interface TimeDescriptor {
-	readonly days?: number;
-	readonly hours?: number;
-	readonly minutes?: number;
-	readonly seconds?: number;
-	readonly milliseconds?: number;
-	readonly microseconds?: number;
-	readonly nanoseconds?: number;
+declare namespace toMilliseconds {
+	interface TimeDescriptor {
+		readonly days?: number;
+		readonly hours?: number;
+		readonly minutes?: number;
+		readonly seconds?: number;
+		readonly milliseconds?: number;
+		readonly microseconds?: number;
+		readonly nanoseconds?: number;
+	}
 }
 
-/**
-Convert an object of time properties to milliseconds: `{seconds: 2}` → `2000`.
-*/
-export default function toMilliseconds(input: TimeDescriptor): number;
+declare const toMilliseconds: {
+	/**
+	Convert an object of time properties to milliseconds: `{seconds: 2}` → `2000`.
+
+	@example
+	```
+	import toMilliseconds = require('@sindresorhus/to-milliseconds');
+
+	toMilliseconds({
+		days: 15,
+		hours: 11,
+		minutes: 23,
+		seconds: 20,
+		milliseconds: 1
+	});
+	//=> 1337000001
+
+	setTimeout(() => {
+		// …
+	}, toMilliseconds({minutes: 2}));
+	```
+	*/
+	(timeDescriptor: toMilliseconds.TimeDescriptor): number;
+
+	// TODO: remove this for next major version
+	default: typeof toMilliseconds;
+};
+
+export = toMilliseconds;

index.js

@@ -26,2 +26,3 @@ 'use strict';
 module.exports = toMilliseconds;
+// TODO: remove this for next major version
 module.exports.default = toMilliseconds;

package.json

 {
 	"name": "@sindresorhus/to-milliseconds",
-	"version": "1.1.0",
+	"version": "1.2.0",
 	"description": "Convert an object of time properties to milliseconds: `{seconds: 2}` → `2000`",
@@ -16,3 +16,3 @@ "license": "MIT",
 	"scripts": {
-		"test": "xo && ava && tsd-check"
+		"test": "xo && ava && tsd"
 	},
@@ -40,6 +40,6 @@ "files": [
 	"devDependencies": {
-		"ava": "^1.3.1",
-		"tsd-check": "^0.5.0",
+		"ava": "^1.4.1",
+		"tsd": "^0.7.1",
 		"xo": "^0.24.0"
 	}
 }

No alert changes

Improved metrics

Total package byte prevSize

4488

increased by11.64%

Lines of code

57

increased by67.65%

No dependency changes