@types/stoppable - npm Package Compare versions

Comparing version 1.1.0 to 1.1.1

stoppable/index.d.ts

@@ -5,15 +5,43 @@ // Type definitions for stoppable 1.1
 //                 John Plusjé <https://github.com/jplusje>
+//                 BendingBender <https://github.com/BendingBender>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
 /// <reference types="node" />
-import { Server } from 'http';
+import * as http from "http";
+import * as https from "https";
 
 declare namespace stoppable {
-  interface StoppableServer extends Server {
-    stop(callback?: (e: Error, gracefully: boolean) => void): void;
-  }
+    // Left for backwards compatibility
+    type StoppableServer = http.Server & WithStop;
+
+    interface WithStop {
+        /**
+         * Closes the server.
+         *
+         * @param callback Passed along to the existing `server.close` function to
+         * auto-register a `'close'` event. The first agrument is an error, and
+         * the second argument indicates whether it stopped gracefully.
+         */
+        stop(callback?: (e: Error | undefined, gracefully: boolean) => any): void;
+    }
 }
 
-declare function stoppable(server: Server, grace?: number): stoppable.StoppableServer;
+/**
+ * Decorates a server instance with a `stop` method.
+ *
+ * @param server Any HTTP or HTTPS Server instance.
+ * @param grace Milliseconds to wait before force-closing connections. Defaults to
+ *              `Infinity` (don't force-close). If you want to immediately kill all sockets
+ *              you can use a grace of `0`.
+ * @returns The server instance, so can be chained, or can be run as a standalone statement.
+ *
+ * @example
+ * import * as http from 'http';
+ * import stoppable = require('stoppable');
+ *
+ * const server = stoppable(http.createServer((req, res) => {}));
+ * server.stop();
+ */
+declare function stoppable<T extends http.Server | https.Server>(server: T, grace?: number): T & stoppable.WithStop;
 
 export = stoppable;

stoppable/package.json

 {
     "name": "@types/stoppable",
-    "version": "1.1.0",
+    "version": "1.1.1",
     "description": "TypeScript definitions for stoppable",
+    "homepage": "https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stoppable",
     "license": "MIT",
@@ -16,9 +17,15 @@ "contributors": [
             "githubUsername": "jplusje"
+        },
+        {
+            "name": "BendingBender",
+            "url": "https://github.com/BendingBender",
+            "githubUsername": "BendingBender"
         }
     ],
     "main": "",
-    "types": "index",
+    "types": "index.d.ts",
     "repository": {
         "type": "git",
-        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git"
+        "url": "https://github.com/DefinitelyTyped/DefinitelyTyped.git",
+        "directory": "types/stoppable"
     },
@@ -29,4 +36,4 @@ "scripts": {},
     },
-    "typesPublisherContentHash": "ac410208bae9e39dea777577e68d5b26d4eae29b7c67e697e476e44cd573dfb1",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "9d6aed80d51a632fcd46a781556cba3ba6ce7c749fe00919cd4be55dedc1aba4",
+    "typeScriptVersion": "3.6"
 }

stoppable/README.md

@@ -8,10 +8,60 @@ # Installation
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stoppable
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stoppable.
+## [index.d.ts](https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/stoppable/index.d.ts)
+````ts
+// Type definitions for stoppable 1.1
+// Project: https://github.com/hunterloftis/stoppable
+// Definitions by: Eric Byers <https://github.com/EricByers>
+//                 John Plusjé <https://github.com/jplusje>
+//                 BendingBender <https://github.com/BendingBender>
+// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 
-Additional Details
- * Last updated: Wed, 28 Nov 2018 17:11:31 GMT
- * Dependencies: node
+/// <reference types="node" />
+import * as http from "http";
+import * as https from "https";
+
+declare namespace stoppable {
+    // Left for backwards compatibility
+    type StoppableServer = http.Server & WithStop;
+
+    interface WithStop {
+        /**
+         * Closes the server.
+         *
+         * @param callback Passed along to the existing `server.close` function to
+         * auto-register a `'close'` event. The first agrument is an error, and
+         * the second argument indicates whether it stopped gracefully.
+         */
+        stop(callback?: (e: Error | undefined, gracefully: boolean) => any): void;
+    }
+}
+
+/**
+ * Decorates a server instance with a `stop` method.
+ *
+ * @param server Any HTTP or HTTPS Server instance.
+ * @param grace Milliseconds to wait before force-closing connections. Defaults to
+ *              `Infinity` (don't force-close). If you want to immediately kill all sockets
+ *              you can use a grace of `0`.
+ * @returns The server instance, so can be chained, or can be run as a standalone statement.
+ *
+ * @example
+ * import * as http from 'http';
+ * import stoppable = require('stoppable');
+ *
+ * const server = stoppable(http.createServer((req, res) => {}));
+ * server.stop();
+ */
+declare function stoppable<T extends http.Server | https.Server>(server: T, grace?: number): T & stoppable.WithStop;
+
+export = stoppable;
+
+````
+
+### Additional Details
+ * Last updated: Mon, 31 May 2021 17:01:23 GMT
+ * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 
 # Credits
-These definitions were written by Eric Byers <https://github.com/EricByers>, John Plusjé <https://github.com/jplusje>.
+These definitions were written by [Eric Byers](https://github.com/EricByers), [John Plusjé](https://github.com/jplusje), and [BendingBender](https://github.com/BendingBender).

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

No website

Quality

Package does not have a website.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

6500

increased by106.15%

Lines of code

41

increased by192.86%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

67

increased by294.12%

No dependency changes