@c8y/toolkit/dist/utils/deploy.d.ts

Toolkit for Cumulocity applications, allows to e.g. deploy an application to an instance of Cumulocity.

import { ApplicationAvailability } from '@c8y/client';
import { ReadStream } from 'fs';
import { DeploymentOptions, ManifestDetails } from './deploy.model';
export declare function deployZipFile(zipPath: string, options: {
    user: string;
    password: string;
    url: string;
    tenant?: string;
    tags?: string;
    rollingTags?: boolean;
    addWebSdkStableTag?: boolean;
    deleteExistingTags?: boolean;
    availability?: ApplicationAvailability;
}): Promise<void>;
/**
 * Reads zipped file by provided path, extracts application metadata, file metadata and file buffer (raw data).
 *
 * @param path - The path to the zip file.
 * @returns A Promise that resolves to object representing the application.
 */
export declare function getAppAsZip(path: string): Promise<{
    fileName: string;
    json: ManifestDetails;
    buffer: ReadStream;
    size: number;
}>;
/**
 * Uploads an application to server, make it active and subscribes tenant to this app.
 *
 * @param appToDeploy - The application to deploy.
 * @returns A Promise that resolves when the deployment is complete.
 */
export declare function deploy(deployOptions: DeploymentOptions): Promise<void>;