human-signals - npm Package Compare versions

Comparing version 4.0.0 to 4.1.0

build/src/main.d.ts

 /**
- * Object whose keys are signal names and values are signal objects.
+ * What is the default action for this signal when it is not handled.
  */
-export declare const signalsByName: { [signalName: string]: Signal }
+export type SignalAction = 'terminate' | 'core' | 'ignore' | 'pause' | 'unpause'
+
 /**
- * Object whose keys are signal numbers and values are signal objects.
+ * Which standard defined that signal.
  */
-export declare const signalsByNumber: { [signalNumber: string]: Signal }
+export type SignalStandard = 'ansi' | 'posix' | 'bsd' | 'systemv' | 'other'
 
-export declare type SignalAction =
-  | 'terminate'
-  | 'core'
-  | 'ignore'
-  | 'pause'
-  | 'unpause'
-export declare type SignalStandard =
-  | 'ansi'
-  | 'posix'
-  | 'bsd'
-  | 'systemv'
-  | 'other'
+/**
+ * Standard name of the signal, for example 'SIGINT'.
+ */
+export type SignalName = `SIG${string}`
 
-export declare type Signal = {
+/**
+ * Code number of the signal, for example 2.
+ * While most number are cross-platform, some are different between different
+ * OS.
+ */
+export type SignalNumber = number
+
+export type Signal = {
   /**
    * Standard name of the signal, for example 'SIGINT'.
    */
-  name: string
+  name: SignalName
+
   /**
-   * Code number of the signal, for example 2. While most number are cross-platform, some are different between different OS.
+   * Code number of the signal, for example 2.
+   * While most number are cross-platform, some are different between different
+   * OS.
    */
-  number: number
+  number: SignalNumber
+
   /**
-   * Human-friendly description for the signal, for example 'User interruption with CTRL-C'.
+   * Human-friendly description for the signal, for example
+   * 'User interruption with CTRL-C'.
    */
   description: string
+
   /**
-   * Whether the current OS can handle this signal in Node.js using process.on(name, handler). The list of supported signals is OS-specific.
+   * Whether the current OS can handle this signal in Node.js using
+   * `process.on(name, handler)`. The list of supported signals is OS-specific.
    */
   supported: boolean
+
   /**
@@ -44,6 +52,9 @@ * What is the default action for this signal when it is not handled.
   action: SignalAction
+
   /**
-   * Whether the signal's default action cannot be prevented. This is true for SIGTERM, SIGKILL and SIGSTOP.
+   * Whether the signal's default action cannot be prevented.
+   * This is true for SIGTERM, SIGKILL and SIGSTOP.
    */
   forced: boolean
+
   /**
@@ -54,1 +65,11 @@ * Which standard defined that signal.
 }
+
+/**
+ * Object whose keys are signal names and values are signal objects.
+ */
+export declare const signalsByName: { [signalName: SignalName]: Signal }
+
+/**
+ * Object whose keys are signal numbers and values are signal objects.
+ */
+export declare const signalsByNumber: { [signalNumber: SignalNumber]: Signal }

package.json

 {
   "name": "human-signals",
-  "version": "4.0.0",
+  "version": "4.1.0",
   "type": "module",
   "exports": "./build/src/main.js",
   "main": "./build/src/main.js",
+  "types": "./build/src/main.d.ts",
   "files": [
-    "build/src/**/*.{js,ts,map,json,sh,md}",
-    "examples/**/*.{js,ts,map,json,sh,md}"
+    "build/src/**/*.{js,d.ts,map,json,sh,md}",
+    "examples/**/*.{js,d.ts,map,json,sh,md}"
   ],
@@ -20,3 +21,2 @@ "scripts": {
     "error-handling",
-    "errors",
     "interrupts",
@@ -33,2 +33,3 @@ "sigterm",
     "javascript",
+    "typescript",
     "linux",
@@ -50,7 +51,7 @@ "macos",
   },
-  "types": "build/src/main.d.ts",
   "devDependencies": {
-    "@ehmicky/dev-tasks": "^1.0.72",
-    "ajv": "^6.12.6",
-    "test-each": "^5.0.0"
+    "@ehmicky/dev-tasks": "^1.0.77",
+    "ajv": "^8.11.0",
+    "test-each": "^5.0.0",
+    "tsd": "^0.21.0"
   },
@@ -57,0 +58,0 @@ "engines": {

README.md

 [![Codecov](https://img.shields.io/codecov/c/github/ehmicky/human-signals.svg?label=tested&logo=codecov)](https://codecov.io/gh/ehmicky/human-signals)
-[![Build](https://github.com/ehmicky/human-signals/workflows/Build/badge.svg)](https://github.com/ehmicky/human-signals/actions)
 [![Node](https://img.shields.io/node/v/human-signals.svg?logo=node.js)](https://www.npmjs.com/package/human-signals)
-[![Twitter](https://img.shields.io/badge/%E2%80%8B-twitter-4cc61e.svg?logo=twitter)](https://twitter.com/intent/follow?screen_name=ehmicky)
-[![Medium](https://img.shields.io/badge/%E2%80%8B-medium-4cc61e.svg?logo=medium)](https://medium.com/@ehmicky)
+[![TypeScript](https://img.shields.io/badge/-typed-brightgreen?logo=typescript&colorA=gray)](/src/main.d.ts)
+[![Twitter](https://img.shields.io/badge/%E2%80%8B-twitter-brightgreen.svg?logo=twitter)](https://twitter.com/intent/follow?screen_name=ehmicky)
+[![Medium](https://img.shields.io/badge/%E2%80%8B-medium-brightgreen.svg?logo=medium)](https://medium.com/@ehmicky)
 
@@ -7,0 +7,0 @@ Human-friendly process signals.

No alert changes

Improved metrics

Total package byte prevSize

43797

increased by0.57%

Lines of code

383

increased by2.96%

Worsened metrics

Dev dependency count

4

increased by33.33%

No dependency changes