node-docker-api/lib/task.d.ts

import Modem = require('docker-modem');
/**
 * Class representing a task
 */
export declare class Task {
    modem: Modem;
    id: String;
    data: Object;
    /**
     * Create a task
     * @param  {Modem}      modem     Modem to connect to the remote service
     * @param  {string}     id        Id of the task (optional)
     */
    constructor(modem: Modem, id: String);
    /**
     * Get low-level information on a task
     * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/inspect-a-task
     * The reason why this module isn't called inspect is because that interferes with the inspect utility of task.
     * @param  {Object}   opts  Query params in the request (optional)
     * @param  {String}   id    ID of the task to inspect, if it's not set, use the id of the object (optional)
     * @return {Promise}        Promise return the task
     */
    status(opts?: Object): Promise<{}>;
}
export default class  {
    modem: Modem;
    /**
     * Create a task
     * @param  {Modem}      modem     Modem to connect to the remote service
     * @param  {string}     id        Id of the task (optional)
     */
    constructor(modem: Modem);
    /**
     * Get a Task object
     * @param  {id}         string    ID of the secret
     * @return {Task}
     */
    get(id: String): Task;
    /**
     * Get the list of tasks
     * https://docs.docker.com/engine/reference/api/docker_remote_api_v1.24/#/list-tasks
     * @param  {Object}   opts  Query params in the request (optional)
     * @return {Promise}        Promise returning the result as a list of tasks
     */
    list(opts?: Object): Promise<Array<Task>>;
}