cnabjs/js/ts/validation.d.ts

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

import { Bundle } from "./bundle-manifest";
/**
 * Indicates that a parameter value is valid according to its schema.
 */
export interface Valid {
    /**
     * Indicates that the parameter value is valid according to its schema.
     */
    readonly isValid: true;
}
/**
 * Indicates that a parameter value is invalid according to its schema.
 */
export interface Invalid {
    /**
     * Indicates that a parameter value is invalid according to its schema.
     */
    readonly isValid: false;
    /**
     * The reason the value is invalid.
     */
    readonly reason: string;
}
/**
 * Indicates whether a parameter value is valid according to its schema.
 */
export declare type Validity = Valid | Invalid;
/**
 * Provides parameter value validation for a bundle.
 */
export interface BundleParameterValidator {
    /**
     * Determines whether a value is a valid value for a parameter.
     * @param parameter The name of the parameter.
     * @param value The value to validate.
     * @returns Whether the value is valid for the parameter.
     */
    validate(parameter: string, value: string | number | boolean): Validity;
    /**
     * Determines whether a text string represents a valid value for a parameter.
     * This is useful when the value comes from a user interface such as a HTML
     * input box.
     * @param parameter The name of the parameter.
     * @param valueText The string to validate.
     * @returns Whether the string represents a valid value for the parameter.
     */
    validateText(parameter: string, valueText: string): Validity;
}
/**
 * Provides parameter value validation for a bundle.
 */
export declare namespace Validator {
    /**
     * Creates a parameter validator for a CNAB bundle.
     * @param bundle The bundle containing parameter declarations and definitions.
     * @returns An object which can be used to perform parameter validation
     * according to the schema defined in the bundle.
     */
    function forBundle(bundle: Bundle): BundleParameterValidator;
}