balena-config-json/build/config.d.ts

Balena config.json manipulation utilities

import { getBootPartition } from './utils';
export { getBootPartition };
export interface ConfigJson {
    [key: string]: any;
}
/**
 * @summary Read a config.json from an image
 * @function
 * @public
 *
 * @param {String} image - image or drive path
 * @param {String} _type - ignored (device type, no longer required)
 *
 * @fulfil {Object} - config.json
 * @returns {Promise}
 *
 * @example
 * config.read('/dev/disk2', 'raspberry-pi').then (config) ->
 * 	console.log(config)
 */
export declare function read(image: string, _type?: string): Promise<ConfigJson>;
/**
 * @summary Write a config.json to an image
 * @function
 * @public
 *
 * @param {String} image - image or drive path
 * @param {String} _type - ignored (device type, no longer required)
 * @param {Object} config - config.json
 *
 * @returns {Promise}
 *
 * @example
 * config.write '/dev/disk2', 'raspberry-pi',
 * 	username: 'foobar'
 * .then ->
 * 	console.log('Done!')
 */
export declare function write(image: string, _type: string | undefined, config: ConfigJson): Promise<void>;