Next Planet of Monkeys

    ts-fs-promise

    1.0.4 • Public • Published

    Installation

    npm install ts-fs-promise --save
    

    Interface path

    <reference path="PATH-TO-ROOT/node_modules/ts-fs-promise/src/FsPromise.d.ts">
    

    API

    • copy(src:string, dest:string, filter?:(src:string) => boolean):Promise<boolean>;
    • copySync(src:string, dest:string, filter?:(src:string) => boolean):void;
    • createFile(file:string):Promise<boolean>;
    • createFileSync(file:string):void;
    • mkdirs(dir:string):Promise<boolean>;
    • mkdirsSync(dir:string):void;
    • outputFile(file:string, data:any):Promise<boolean>;
    • outputFileSync(file:string, data:any):void;
    • outputJSON(file:string, data:any):Promise<boolean>;
    • outputJSONSync(file:string, data:any):void;
    • readJSON(file:string, options?:tsFsPromise.OpenOptions):Promise<any>;
    • readJSONSync(file:string, options?:tsFsPromise.OpenOptions):any;
    • remove(dir:string):Promise<boolean>;
    • removeSync(dir:string):void;
    • writeJSON(file:string, object:any, options?:tsFsPromise.OpenOptions):Promise<boolean>;
    • writeJSONSync(file:string, object:any, options?:tsFsPromise.OpenOptions):void;
    • rename(oldPath:string, newPath:string):Promise<boolean>;
    • renameSync(oldPath:string, newPath:string):void;
    • truncate(fd:number, len:number):Promise<boolean>;
    • truncateSync(fd:number, len:number):void;
    • chown(path:string, uid:number, gid:number):Promise<boolean>;
    • chownSync(path:string, uid:number, gid:number):void;
    • fchown(fd:number, uid:number, gid:number):Promise<boolean>;
    • fchownSync(fd:number, uid:number, gid:number):void;
    • lchown(path:string, uid:number, gid:number):Promise<boolean>;
    • lchownSync(path:string, uid:number, gid:number):void;
    • chmodSync(path:string, mode:number):void;
    • fchmod(fd:number, mode:number):Promise<boolean>;
    • fchmodSync(fd:number, mode:number):void;
    • lchmod(path:string, mode:string):Promise<boolean>;
    • lchmodSync(path:string, mode:string):void;
    • stat(path:string):Promise<tsFsPromise.Stats>;
    • statSync(path: string): tsFsPromise.Stats;
    • readFile(path:string, encoding):Promise<any>;
    • readFileSync(filename: string, encoding):any;
    • writeFile(filename:string, data:any, encoding?:string):Promise<boolean>;
    • writeFileSync(filename: string, data: any, encoding?: string):void;
    • readdir(path:string):Promise<Array<string>>;
    • readdirSync(path:string):Array<string>;

    Example

     <reference path="./node_modules/ts-fs-promise/src/FsPromise.d.ts">
     import fs = require('ts-fs-promise');
     
     fs.readFile('some.txt', 'utf8').then((fileText:string) => {
        // do something
     });
    

    Fixes

    version 1.0.2 fix copy
    version 1.0.3 fix createFile

    Version 1.0.4


    License

    MIT

    Install

    npm i ts-fs-promise

    DownloadsWeekly Downloads

    50

    Version

    1.0.4

    License

    MIT

    Last publish

    Collaborators

    • tsigel