balena-config-json

balena-config-json

Balena config.json manipulation utilities.

Role

The intention of this module is to provide low level utilities to read and write config.json from balena devices.

THIS MODULE IS LOW LEVEL AND IS NOT MEANT TO BE USED BY END USERS DIRECTLY.

Installation

Install balena-config-json by running:

$ npm install --save balena-config-json

Documentation

• config
  • ~read(image, _type) ⇒ Promise
  • ~write(image, _type, config) ⇒ Promise

config~read(image, _type) ⇒ Promise

Kind: inner method of config
Summary: Read a config.json from an image
Access: public
Fulfil: Object - config.json

Param	Type	Description
image	String	image or drive path
_type	String	ignored (device type, no longer required)

Example

config.read('/dev/disk2', 'raspberry-pi').then (config) ->
	console.log(config)

config~write(image, _type, config) ⇒ Promise

Kind: inner method of config
Summary: Write a config.json to an image
Access: public

Param	Type	Description
image	String	image or drive path
_type	String	ignored (device type, no longer required)
config	Object	config.json

Example

config.write '/dev/disk2', 'raspberry-pi',
	username: 'foobar'
.then ->
	console.log('Done!')

Support

If you're having any problem, please raise an issue on GitHub and the balena team will be happy to help.

Tests

Run the test suite by doing:

$ gulp test

Contribute

• Issue Tracker: github.com/balena-io-modules/balena-config-json/issues
• Source Code: github.com/balena-io-modules/balena-config-json

Before submitting a PR, please make sure that you include tests, and that npm run lint runs without any warning:

$ gulp lint

License

The project is licensed under the Apache 2.0 license.

Changelog

4.2.0 - 2021-10-22

• Avoid need for internet access (replace API query with image inspection) [Paulo Castro]
• Convert lib/config.js to TypeScript [Paulo Castro]
• Update dependencies, .gitignore, .npmrc [Paulo Castro]