balena-sdk/es2017/models/image.d.ts

The Balena JavaScript SDK

import type { Image, InjectedDependenciesParam } from '..';
import type { ODataOptionsWithoutCount, OptionsToResponse } from 'pinejs-client-core';
declare const getImageModel: (deps: InjectedDependenciesParam) => {
    /**
     * @summary Get a specific image
     * @name get
     * @public
     * @function
     * @memberof balena.models.image
     *
     * @param {Number} id - image id
     * @param {Object} [options={}] - extra pine options to use
     * @fulfil {Object} - image
     * @returns {Promise}
     *
     * @example
     * balena.models.image.get(123).then(function(image) {
     * 	console.log(image);
     * });
     */
    get<T extends ODataOptionsWithoutCount<Image["Read"]>>(id: number, options?: T): Promise<OptionsToResponse<Image["Read"], T, undefined>[number]>;
    /**
     * @summary Get the logs for an image
     * @name getLogs
     * @public
     * @function
     * @memberof balena.models.image
     *
     * @param {Number} id - image id
     * @fulfil {string | null} - logs
     * @returns {Promise}
     *
     * @example
     * balena.models.image.getLogs(123).then(function(logs) {
     * 	console.log(logs);
     * });
     */
    getLogs: (id: number) => Promise<string | null>;
};
export default getImageModel;