balena-errors
Advanced tools
Balena error collection
The intention of this module is to provide a collection of Error instances to be used by the Balena SDK.
THIS MODULE IS LOW LEVEL AND IS NOT MEANT TO BE USED BY END USERS DIRECTLY.
Unless you know what you're doing, use the Balena SDK instead.
While this module has not been formally deprecated,
we now believe that it is not good practice to add error classes to a separate module like
balena-errors. Instead, error classes should be added to the same module that throws the
errors. The reason is that downstream applications (like the balena CLI) may end up with
multiple versions of balena-errors in the node_modules folder, in order to satisfy
dependencies' own dependencies (e.g. a dependency module requires balena-errors v4, and
another dependency module requires balena-errors v3). When this happens, testing error
instances with instanceof fails: For example, an error class like BalenaExpiredToken
loaded from balena-errors v4 would be considered incompatible (not the same class) as
BalenaExpiredToken loaded from balena-errors v3. And this leads to bugs...
Install balena-errors by running:
$ npm install --save balena-errors
Kind: inner class of errors
Summary: Balena too many requests
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| nextValidRequestDate | String | next valid request string date |
Example
throw new errors.BalenaTooManyRequests()
Kind: inner class of errors
Summary: Balena invalid login credentials
Access: public
Kind: inner class of errors
Summary: Balena invalid device type
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| type | String | device type |
Example
throw new errors.BalenaInvalidDeviceType('raspberry-pi')
Kind: inner class of errors
Summary: Balena discontinued device type
Access: public
The device type that you specified is invalid because it is discontinued, and this operation is no longer supported.
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| type | String | device type |
Example
throw new errors.BalenaDiscontinuedDeviceType('edge')
Kind: inner class of errors
Summary: Balena malformed token
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| token | String | token |
Example
throw new errors.BalenaMalformedToken('1234')
Kind: inner class of errors
Summary: Balena settings permission error
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| error | Error | usually an EACCESS error |
Example
throw new errors.BalenaSettingsPermissionError()
Kind: inner class of errors
Summary: The device supervisor is locked
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| token | String | token |
Example
throw new errors.BalenaSupervisorLockedError()
Kind: inner class of errors
Summary: Balena expired token
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| token | String | token |
Example
throw new errors.BalenaExpiredToken('1234')
Kind: inner class of errors
Summary: Balena application not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| application | String | Number | application name or id |
Example
throw new errors.BalenaApplicationNotFound('MyApp')
Kind: inner class of errors
Summary: Balena release not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| release | String | Number | release commit or id |
Example
throw new errors.BalenaReleaseNotFound(123)
Kind: inner class of errors
Summary: Balena organization membership role not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| organizationMembershipRole | String | Number | organization membership role name or id |
Example
throw new errors.BalenaOrganizationMembershipRoleNotFound(123)
Kind: inner class of errors
Summary: Balena application membership role not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| applicationMembershipRole | String | Number | application membership role name or id |
Example
throw new errors.BalenaApplicationMembershipRoleNotFound(123)
Kind: inner class of errors
Summary: Balena image not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| image | Number | image id |
Example
throw new errors.BalenaImageNotFound(123)
Kind: inner class of errors
Summary: Balena service not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| service | String | Number | service name or id |
Example
throw new errors.BalenaServiceNotFound(123)
Kind: inner class of errors
Summary: Balena device not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| device | String | Number | device name or id |
Example
throw new errors.BalenaDeviceNotFound('MyDevice')
Kind: inner class of errors
Summary: Balena organization not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| organization | String | Number | organization name or id |
Example
throw new errors.BalenaOrganizationNotFound('MyOrg')
Kind: inner class of errors
Summary: Balena ambiguous device
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| device | String | Number | device name or id |
Example
throw new errors.BalenaAmbiguousDevice('MyDevice')
Kind: inner class of errors
Summary: Balena ambiguous application
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| application | String | Number | application name or id |
Example
throw new errors.BalenaAmbiguousApplication('MyApp')
Kind: inner class of errors
Summary: Balena ambiguous release
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| release | String | release hash |
Example
throw new errors.BalenaAmbiguousRelease('7cf02a6')
Kind: inner class of errors
Summary: Balena key not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| key | String | Number | key name, id or value |
Example
throw new errors.BalenaKeyNotFound('MyKey')
Kind: inner class of errors
Summary: Balena request error
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| body | String | response body |
| statusCode | Number | http status code |
| [requestOptions] | Object | options used to make the request |
| [responseHeaders] | Object | the Headers that were included in the response |
Example
throw new errors.BalenaRequestError('Unauthorized')
Kind: inner class of errors
Summary: Balena not logged in
Access: public
Kind: inner class of errors
Summary: Balena invalid parameter
Access: public
If you're having any problem, please raise an issue on GitHub and the Balena team will be happy to help.
Run the test suite by doing:
$ gulp test
Before submitting a PR, please make sure that you include tests, and that coffeelint runs without any warning:
$ gulp lint
The project is licensed under the Apache 2.0 license.
v4.9.0
FAQs
Collection of Balena JavaScript errors
The npm package balena-errors receives a total of 6,412 weekly downloads. As such, balena-errors popularity was classified as popular.
We found that balena-errors demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Research
A malicious npm package disguised as a WhatsApp client is exploiting authentication flows with a remote kill switch to exfiltrate data and destroy files.
Security News
PyPI now supports digital attestations, enhancing security and trust by allowing package maintainers to verify the authenticity of Python packages.
Security News
GitHub removed 27 malicious pull requests attempting to inject harmful code across multiple open source repositories, in another round of low-effort attacks.