@types/lightship - npm Package Compare versions

Comparing version 3.0.0 to 4.0.0

lightship/index.d.ts

@@ -1,7 +0,9 @@
-// Type definitions for lightship 3.0
+// Type definitions for lightship 4.0
 // Project: https://github.com/gajus/lightship#readme
-// Definitions by: Scott Chang <https://github.com/purmac>
+// Definitions by: Scott Chang <https://github.com/purmac>, Karoun Kasraie <https://github.com/karoun>
 // Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
 /// <reference types="node" />
 
+import { Server } from 'http';
+
 /**
@@ -13,10 +15,16 @@ * A teardown function called when shutdown is initialized.
 
+export type BeaconContextType = object;
+
+export interface BeaconControllerType {
+    die: () => Promise<void>;
+}
+
 export interface UserConfigurationType {
-    /* Run Iapetus only if service is detected ro be running in Kubernetes. Default: true. */
+    /* Run Lightship in local mode when Kubernetes is not detected. Default: true. */
     detectKubernetes?: boolean;
-    /* The port on which the Lightship service listens. This port must be different than your main service port, if any. The default port is 9000.*/
+    /* The port on which the Lightship service listens. This port must be different than your main service port, if any. The default port is 9000. */
     port?: number;
-    /* An a array of [signal events]{@link https://nodejs.org/api/process.html#process_signal_events}. Default: [SIGTERM]. */
+    /* An a array of [signal events]{@link https://nodejs.org/api/process.html#process_signal_events}. Default: [SIGTERM, SIGHUP, SIGINT]. */
     signals?: ReadonlyArray<NodeJS.Signals>;
-    /* A number of milliseconds before force full termination. Default: 60000. */
+    /* A number of milliseconds before forceful termination. Default: 60000. */
     timeout?: number;
@@ -26,2 +34,3 @@ }
 export interface LightshipType {
+    createBeacon: (context?: BeaconContextType) => BeaconControllerType;
     /* Checks if server is in SERVER_IS_READY state */
@@ -37,2 +46,3 @@ isServerReady: () => boolean;
     registerShutdownHandler: (shutdownHandler: ShutdownHandlerType) => void;
+    readonly server: Server;
     /* Changes server state to SERVER_IS_SHUTTING_DOWN and initialises the shutdown of the application.*/
@@ -39,0 +49,0 @@ shutdown: () => Promise<void>;

lightship/package.json

 {
     "name": "@types/lightship",
-    "version": "3.0.0",
+    "version": "4.0.0",
     "description": "TypeScript definitions for lightship",
@@ -11,6 +11,11 @@ "license": "MIT",
             "githubUsername": "purmac"
+        },
+        {
+            "name": "Karoun Kasraie",
+            "url": "https://github.com/karoun",
+            "githubUsername": "karoun"
         }
     ],
     "main": "",
-    "types": "index",
+    "types": "index.d.ts",
     "repository": {
@@ -25,4 +30,4 @@ "type": "git",
     },
-    "typesPublisherContentHash": "b85e9cfc1773c38d8d0c6db86f617ae5bddb411c6664f989d7e0bc62642bf528",
-    "typeScriptVersion": "2.0"
+    "typesPublisherContentHash": "68144e2aef30d1472d10a4301eabb9f9aabbabb3e0eca4e2184542c33d37ddce",
+    "typeScriptVersion": "2.8"
 }

lightship/README.md

@@ -5,13 +5,13 @@ # Installation
 # Summary
-This package contains type definitions for lightship ( https://github.com/gajus/lightship#readme ).
+This package contains type definitions for lightship (https://github.com/gajus/lightship#readme).
 
 # Details
-Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lightship
+Files were exported from https://github.com/DefinitelyTyped/DefinitelyTyped/tree/master/types/lightship.
 
-Additional Details
- * Last updated: Thu, 11 Apr 2019 22:07:32 GMT
- * Dependencies: @types/node
+### Additional Details
+ * Last updated: Fri, 03 Jan 2020 23:09:30 GMT
+ * Dependencies: [@types/node](https://npmjs.com/package/@types/node)
  * Global values: none
 
 # Credits
-These definitions were written by Scott Chang <https://github.com/purmac>.
+These definitions were written by Scott Chang (https://github.com/purmac), and Karoun Kasraie (https://github.com/karoun).

No alert changes

Improved metrics

Total package byte prevSize

5016

increased by12.11%

Lines of code

46

increased by17.95%

No dependency changes