Module

Node.Library.HumanSignals

Package
purescript-node-human-signals
Repository
jordanmartinez/purescript-node-human-signals

#UnhandledAction Source

data UnhandledAction

The default action for a signal if it is not handled.

Constructors

Instances

#StandardSource Source

data StandardSource

Which standard defined the signal

Constructors

Instances

#signals Source

signals :: { byName :: SignalsByName, byNumber :: Map Int HumanSignal, byString :: Object HumanSignal }

Lookup a signal either by its name or number

#HumanSignal Source

type HumanSignal = { action :: UnhandledAction, description :: String, forced :: Boolean, name :: String, number :: Int, standard :: StandardSource, supported :: Boolean }

name = standard name of the signal number = code number of the signal. Most are cross-platform, but some differ between OSes description = Human-friendly description for the signal supported = whether the current OS can handle this signal in Node.js using process.on(name, handler) (see https://nodejs.org/api/process.html#process_signal_events) Note: the list of supported signals is OS-specific. See https://github.com/ehmicky/cross-platform-node-guide/blob/main/docs/6_networking_ipc/signals.md#cross-platform-signals forced = whether the signal's default action cannot be prevented. This is true for action = see type's docs standard = see type's docs