Constructor
new FlitterError(msg, …args)
Instantiate the error. Set a default component name and message.
Parameters:
| Name | Type | Attributes | Default | Description |
|---|---|---|---|---|
msg |
string | Flitter encountered an error. | ||
args |
* |
<repeatable> |
- Source:
Extends
- Error
Members
component :string
Name of the Flitter component that encountered an error.
Type:
- string
- Source:
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 |
- Source:
Returns:
- instance of self to allow chaining
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 |
- Source:
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