balena-errors
Advanced tools
Collection of Balena JavaScript errors
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.
Install balena-errors by running:
$ npm install --save balena-errors
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: 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')
Deprecated
Kind: inner class of errors
Summary: Balena build not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| build | Number | build id |
Example
throw new errors.BalenaBuildNotFound(123)
Kind: inner class of errors
Summary: Balena release not found
Access: public
Returns: Error - error instance
| Param | Type | Description |
|---|---|---|
| release | Number | release id |
Example
throw new errors.BalenaReleaseNotFound(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 | Number | service 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 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 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 |
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.
FAQs
Collection of Balena JavaScript errors
The npm package balena-errors receives a total of 71 weekly downloads. As such, balena-errors popularity was classified as not 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
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.
Security News
require(esm) backported to Node.js 20, easing the transition to ESM-only packages and reducing complexity for developers as Node 18 nears end-of-life.
Security News
PyPI now supports iOS and Android wheels, making it easier for Python developers to distribute mobile packages.