@zowe/imperative
Version:
framework for building configurable CLIs
60 lines • 2.38 kB
TypeScript
import { Arguments } from "yargs";
import { ICommandProfileTypeConfiguration } from "../../cmd/src/doc/profiles/definition/ICommandProfileTypeConfiguration";
import { IProfileSchema } from "../../profiles/src/doc/definition/IProfileSchema";
/**
* @deprecated Use Censor
* Logging utilities
*/
export declare class LoggerUtils {
/**
* @deprecated Use Censor.CENSOR_RESPONSE
*/
static readonly CENSOR_RESPONSE = "****";
/**
* @deprecated Use Censor.CENSORED_OPTIONS
*/
static CENSORED_OPTIONS: string[];
/**
* @deprecated Use Censor.SECURE_PROMPT_OPTIONS
*/
static readonly SECURE_PROMPT_OPTIONS: string[];
/**
* Copy and censor any sensitive CLI arguments before logging/printing
* @param {string[]} args
* @returns {string[]}
* @deprecated Use Censor.censorCLIArgs
*/
static censorCLIArgs(args: string[]): string[];
/**
* Copy and censor a yargs argument object before logging
* @param {yargs.Arguments} args the args to censor
* @returns {yargs.Arguments} a censored copy of the arguments
* @deprecated Use Censor.censorYargsArguments
*/
static censorYargsArguments(args: Arguments): Arguments;
/**
* @deprecated use Censor.profileSchemas
*/
static get profileSchemas(): ICommandProfileTypeConfiguration[];
/**
* @deprecated use Censor.setProfileSchemas
*/
static setProfileSchemas(_schemas: Map<string, IProfileSchema>): void;
/**
* Specifies whether a given property path (e.g. "profiles.lpar1.properties.host") is a special value or not.
* Special value: Refers to any value defined as secure in the schema definition.
* These values should be already masked by the application (and/or plugin) developer.
* @param prop Property path to determine if it is a special value
* @returns True - if the given property is to be treated as a special value; False - otherwise
* @deprecated Use Censor.isSpecialValue
*/
static isSpecialValue: (prop: string) => boolean;
/**
* Copy and censor any sensitive CLI arguments before logging/printing
* @param {string} data
* @returns {string}
* @deprecated Use Censor.censorRawData
*/
static censorRawData(data: string, category?: string): string;
}
//# sourceMappingURL=LoggerUtils.d.ts.map