bare-signals

bare-signals — Native signal handling for JavaScript. It is a native addon and requires Bare >=1.7.0.

npm i bare-signals

Usage

const Signal = require('bare-signals')

const sigint = new Signal('SIGINT')

sigint.on('signal', () => console.log('SIGINT caught')).start()

API

Signal

new Signal(signum: number | string)

Create a Signal for signum, given as a signal number or name such as 'SIGINT'. Throws if signum is a string that names an unknown signal.

Parameters

Throws

• UNKNOWN_SIGNAL — signum is a string that does not name a known signal.

close(): Promise<void>

Close the signal, releasing its underlying handle. Returns a promise that resolves once the close event has fired.

Signal.ref(): this

Ref the signal, keeping the event loop alive while it is active.

Signal.constants: Record<string, number>

The map of known signal names to signal numbers.

start(): this

Start listening for the signal, emitting signal when it is received. Throws if the signal has been closed.

Throws

• SIGNAL_CLOSED — the signal has been closed.

stop(): this

Stop listening for the signal.

Signal.unref(): this

Unref the signal, allowing the event loop to exit even while it is active.

SignalEmitter

SignalEmitter.ref(): this

Ref all currently tracked signals, keeping the event loop alive.

SignalEmitter.unref(): this

Unref all currently tracked signals, allowing the event loop to exit.

Classes

SignalError

class SignalError {
  code: string
}

See also

• Bare modules — the full bare-* catalog.
• Bare runtime API — the runtime these modules extend.