util.env/index.d.ts

export declare enum EnvType {
    development = "development",
    test = "test",
    production = "production",
}
export declare const root: string;
/**
 * Retrieves a string that represents the name of a branch in git for a
 * mode.
 *
 * - development => "develop"
 * - test => "master"
 * - production => "v##.##.##"
 */
export declare function getBranch(): string;
/**
 * Retrieves the environment mode type.  There are three types:
 *
 * - development
 * - test
 * - production
 *
 * It will first try to get the type from the NODE_ENV variable.  If this
 * is not found, then it will look for the a command line argument for the
 * type.  If this is not found, then the default of "development" is
 * returned.
 */
export declare function getMode(): string;
/**
 * Checks if the environment is development.
 * @returns {boolean} returns true if development, otherwise false.
 */
export declare function isDevelopment(): boolean;
/**
 * Checks if the environment is testing.
 * @returns {boolean} returns true if testing, otherwise false.
 */
export declare function isTesting(): boolean;
/**
 * Checks if the environment is production.
 * @returns {boolean} returns true if production, otherwise false.
 */
export declare function isProduction(): boolean;
/**
 * Builds the version label from the environment.  It determines the current
 * git branch, the number of revisions in that branch, and the build number
 * supplied by Jenkins.  If the build number is not found it is set to 0.  The
 * resulting version label is:
 *
 *     {branch}-r{# of revisions}_b{build number}
 *
 *     e.g.
 *
 *     develop-r05_b0
 *
 * When this is a production environment type, then the semver from the package
 * is used to create the version label.
 *
 * @returns {string} a string that represnets the
 */
export declare function getVersion(): string;
export declare function show(log?: {
    (message?: any, ...optionalParams: any[]): void;
    (message?: any, ...optionalParams: any[]): void;
}): void;