CliFs

@tsed/cli-core

Usage

import { CliFs } from "@tsed/cli-core";

See /packages/cli-core/src/services/CliFs.ts.

Overview

class CliFs extends RealFileSystemHost {
    raw: typeof Fs;
    exists(path: string): boolean;
    join(...args: string[]): string;
    readFile(file: string | Buffer | number, encoding?: any): Promise<string>;
    readFileSync(file: string | Buffer | number, encoding?: any): any;
    readJson(file: string, encoding?: any): Promise<any>;
    readJsonSync(file: string, encoding?: any): any;
    writeJson(file: string | Buffer | number, data: any, options?: WriteFileOptions | string): Promise<any>;
    writeJsonSync(file: string | Buffer | number, data: any, options?: WriteFileOptions | string): void;
    writeFileSync(path: PathLike | number, data: any, options?: WriteFileOptions): void;
    writeFile(file: string | Buffer | number, data: any, options?: WriteFileOptions | string): Promise<void>;
    ensureDir(path: string, options?: EnsureDirOptions | number): Promise<void>;
    ensureDirSync(path: string, options?: EnsureDirOptions | number): void;
    findUpFile(root: string, file: string): string | undefined;
    importModule(mod: string, root?: string): Promise<any>;
}

raw

raw: typeof Fs;

exists

exists(path: string): boolean;

join

join(...args: string[]): string;

readFile

readFile(file: string | Buffer | number, encoding?: any): Promise<string>;

readFileSync

readFileSync(file: string | Buffer | number, encoding?: any): any;

readJson

readJson(file: string, encoding?: any): Promise<any>;

readJsonSync

readJsonSync(file: string, encoding?: any): any;

writeJson

writeJson(file: string | Buffer | number, data: any, options?: WriteFileOptions | string): Promise<any>;

writeJsonSync

writeJsonSync(file: string | Buffer | number, data: any, options?: WriteFileOptions | string): void;

writeFileSync

writeFileSync(path: PathLike | number, data: any, options?: WriteFileOptions): void;

writeFile

writeFile(file: string | Buffer | number, data: any, options?: WriteFileOptions | string): Promise<void>;

ensureDir

ensureDir(path: string, options?: EnsureDirOptions | number): Promise<void>;

ensureDirSync

ensureDirSync(path: string, options?: EnsureDirOptions | number): void;

findUpFile

findUpFile(root: string, file: string): string | undefined;

importModule

importModule(mod: string, root?: string): Promise<any>;