@microsoft/windows-admin-center-sdk/tools/wac-cli/src/common.d.ts

Microsoft - Windows Admin Center Shell

/**
 * Error resolution states
 */
export declare enum ResolveState {
    Resolved = "RESOLVED",
    Unresolved = "UNRESOLVED"
}
export declare class Common {
    static readonly cliRootPath: string;
    static readonly moduleTemplatePath: string;
    private static _rootPath;
    /**
     * Gets the root path for the current repository
     * @returns {string} Root path for the current repository
     */
    static get rootPath(): string;
    /**
     * Sets the root path for the current repository
     * @param {string} path Root path for the current repository
     */
    static set rootPath(path: string);
    /**
     * Retrieves content of given file
     * @param {string} filePath Target file path
     * @returns {string | null} String representation of file content or null if file was not found
     */
    static readFileData(filePath: any): any;
    /**
     * Writes to the content of given file
     * @param {string} filePath Target file path
     * @returns {boolean} indicates whether the file was written successfully.
     */
    static writeFileData(filePath: any, newContent: any): boolean;
    /**
     * Creates the file with content.
     * @param {string} filePath Target file path
     * @param {string} newContent Content to write to the file
     */
    static writeFile(filePath: any, newContent: any): Promise<void>;
    /**
     * Retrieves content of given JSON file and parses into an object
     * @param {string} filePath Target file path
     * @returns {any | null} Parsed JSON object or null if file was not found
     */
    static readFileJSON(filePath: any): any;
    /**
     * Replaces part of target string with a new string using given regex
     * @param {string} originalString Target string
     * @param {RegExp} regexToReplace Regex to apply to target string
     * @param {string} newString String that will replace regex matches
     * @returns {string} New string created from replacing regex matches or original string if no matches were found
     */
    static replaceInString(originalString: any, regexToReplace: any, newString: any): any;
}