cnabjs/js/ts/parameters.d.ts

A library for loading and working with CNAB (Cloud Native Application Bundle) manifests

import { Bundle } from "./bundle-manifest";
export declare namespace Parameters {
    /**
     * Gets the parameters applicable to a specific action, such as 'install'.
     * @param bundle The bundle from which to get parameters.
     * @param actionName The action whose parameters you are requesting.
     * @returns The names of the parameters which apply the specified action.
     */
    function forAction(bundle: Bundle, actionName: string): ReadonlyArray<string>;
    /**
     * Gets whether a particular parameter is required to be specified.
     * @param bundle The bundle containg the parameters.
     * @param parameterName The name of the parameter to check.
     * @returns Whether the parameter is required.
     */
    function isRequired(bundle: Bundle, parameterName: string): boolean;
}