aboutsummaryrefslogtreecommitdiff
path: root/node_modules/human-signals/build/src/main.d.ts
blob: 2dc5ea78e5383691060a2ca55bb0ba1a884f90b8 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
/**
 * Object whose keys are signal names and values are signal objects.
 */
export declare const signalsByName: { [signalName: string]: Signal }
/**
 * Object whose keys are signal numbers and values are signal objects.
 */
export declare const signalsByNumber: { [signalNumber: string]: Signal }

export declare type SignalAction =
  | 'terminate'
  | 'core'
  | 'ignore'
  | 'pause'
  | 'unpause'
export declare type SignalStandard =
  | 'ansi'
  | 'posix'
  | 'bsd'
  | 'systemv'
  | 'other'

export declare type Signal = {
  /**
   * Standard name of the signal, for example 'SIGINT'.
   */
  name: string
  /**
   * Code number of the signal, for example 2. While most number are cross-platform, some are different between different OS.
   */
  number: number
  /**
   * 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.
   */
  supported: boolean
  /**
   * 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.
   */
  forced: boolean
  /**
   * Which standard defined that signal.
   */
  standard: SignalStandard
}