StopError

libflitter/errors/SoftError~ StopError

An error that, if thrown within Flitter, indicates that a non-fatal error has occurred. Flitter will not shut down after this error, but the exit code will change.

If thrown while a Unit is initializing, the unit's status will be set to Unit.STATUS_ERROR, and any units that depend on it will fail to start.

Constructor

new StopError()

Source:: libflitter/errors/SoftError.js, line 18

Extends

module:libflitter/errors/FlitterError~FlitterError

Members

component :string

Name of the Flitter component that encountered an error.

Type:

string

Overrides:: module:libflitter/errors/FlitterError~FlitterError#component
Source:: libflitter/errors/FlitterError.js, line 23

Methods

required(service) → {module:libflitter/errors/FlitterError~FlitterError}

Creates an error message for missing services by name.

Parameters:

Name	Type	Description
`service`	string \| Array.<string>	the name of the service or array of services that are required

Overrides:: module:libflitter/errors/FlitterError~FlitterError#required
Source:: libflitter/errors/FlitterError.js, line 31

Returns:

instance of self to allow chaining

Type: module:libflitter/errors/FlitterError~FlitterError

unit(nameopt) → {string|module:libflitter/errors/FlitterError~FlitterError}

Get or set the component name.

Parameters:

Name	Type	Attributes	Default	Description
`name`	string \| null	<optional>	null	name of the component

Overrides:: module:libflitter/errors/FlitterError~FlitterError#unit
Source:: libflitter/errors/FlitterError.js, line 52

Returns:

If no name is provided, returns the current value of module:libflitter/errors/FlitterError~FlitterError#component. If a name is provided, returns an instance of self to allow chaining.

Type: string | module:libflitter/errors/FlitterError~FlitterError