@atomist/automation-client/project/File.d.ts

Atomist API for software low-level client

import { ScriptedFlushable } from "../internal/common/Flushable";
/**
 * Operations common to all File interfaces
 */
export interface FileCore {
    /**
     * Return file name, excluding path
     *
     * @property {string} name
     */
    readonly name: string;
    /**
     * Return file path, with forward slashes
     *
     * @property {string} path
     */
    readonly path: string;
}
/**
 * Convenient way to defer File operations with fluent API
 */
export interface FileScripting extends ScriptedFlushable<File> {
    /**
     * Set entire file content to new string
     *
     * @param newContent {string} The content to set the file to
     */
    recordSetContent(newContent: string): this;
    recordRename(name: string): this;
    recordSetPath(name: string): this;
    /**
     * Replace all occurrences of the given regular expression with
     * @param re
     * @param replacement
     */
    recordReplace(re: RegExp, replacement: string): this;
    recordReplaceAll(oldLiteral: string, newLiteral: string): this;
}
export interface FileAsync extends FileCore {
    setContent(content: string): Promise<this>;
    rename(name: string): Promise<this>;
    getContent(): Promise<string>;
    replace(re: RegExp, replacement: string): Promise<this>;
    replaceAll(oldLiteral: string, newLiteral: string): Promise<this>;
    setPath(path: string): Promise<this>;
    isExecutable(): Promise<boolean>;
    isReadable(): Promise<boolean>;
    isBinary(): Promise<boolean>;
}
export interface FileNonBlocking extends FileScripting, FileAsync {
}
/**
 * Sychronous file operations. Use with care as they can limit concurrency.
 * Following the conventions of node fs library, they use a "sync" suffix.
 */
export interface FileSync extends FileCore {
    /**
     * Return content. Blocks: use inputStream by preference.
     *
     * @property {string} content
     */
    getContentSync(): string;
    setContentSync(content: string): this;
}
/**
 * Abstraction for a File. Similar to Project abstraction,
 * broken into three distinct styles of usage.
 */
export interface File extends FileScripting, FileSync, FileAsync {
    /**
     * Extension or the empty string if no extension can be determined
     */
    extension: string;
}
export declare function isFile(a: any): a is File;
//# sourceMappingURL=File.d.ts.map