UNPKG

4.37 kBTypeScriptView Raw
1/// <reference types="node" />
2
3import * as Promise from "bluebird";
4import * as fs from "fs";
5import { CopyFilter, CopyOptions, MoveOptions, ReadOptions, WriteOptions } from "fs-extra";
6import * as stream from "stream";
7import Stats = fs.Stats;
8
9export * from "fs-extra";
10
11export interface MkdirOptions {
12 fs?: any;
13 mode?: number | undefined;
14}
15
16// promisified versions
17export function copyAsync(src: string, dest: string, options?: CopyFilter | CopyOptions): Promise<void>;
18
19export function createFileAsync(file: string): Promise<void>;
20
21export function mkdirsAsync(dir: string, options?: MkdirOptions): Promise<void>;
22export function mkdirpAsync(dir: string, options?: MkdirOptions): Promise<void>;
23
24export function moveAsync(src: string, dest: string, options?: MoveOptions): Promise<void>;
25
26export function outputFileAsync(file: string, data: any): Promise<void>;
27
28export function outputJsonAsync(file: string, data: any): Promise<void>;
29export function outputJSONAsync(file: string, data: any): Promise<void>;
30
31export function readJsonAsync(file: string, options?: ReadOptions): Promise<any>;
32export function readJSONAsync(file: string, options?: ReadOptions): Promise<any>;
33
34export function removeAsync(dir: string): Promise<void>;
35
36export function writeJsonAsync(file: string, object: any, options?: WriteOptions): Promise<void>;
37export function writeJSONAsync(file: string, object: any, options?: WriteOptions): Promise<void>;
38
39export function renameAsync(oldPath: string, newPath: string): Promise<void>;
40export function truncateAsync(fd: number, len: number): Promise<void>;
41export function chownAsync(path: string, uid: number, gid: number): Promise<void>;
42export function fchownAsync(fd: number, uid: number, gid: number): Promise<void>;
43export function lchownAsync(path: string, uid: number, gid: number): Promise<void>;
44export function chmodAsync(path: string, mode: number | string): Promise<void>;
45export function fchmodAsync(fd: number, mode: number | string): Promise<void>;
46export function lchmodAsync(path: string, mode: number | string): Promise<void>;
47export function statAsync(path: string): Promise<Stats>;
48export function lstatAsync(path: string): Promise<Stats>;
49export function fstatAsync(fd: number): Promise<Stats>;
50export function linkAsync(srcpath: string, dstpath: string): Promise<void>;
51export function symlinkAsync(srcpath: string, dstpath: string, type?: fs.symlink.Type): Promise<void>;
52export function readlinkAsync(path: string): Promise<string>;
53export function realpathAsync(path: string, cache?: { [path: string]: string }): Promise<string>;
54export function unlinkAsync(path: string): Promise<void>;
55export function rmdirAsync(path: string): Promise<void>;
56export function mkdirAsync(path: string, mode?: number | string): Promise<void>;
57export function readdirAsync(path: string): Promise<string[]>;
58export function closeAsync(fd: number): Promise<void>;
59export function openAsync(path: string, flags: string, mode?: string): Promise<number>;
60export function utimesAsync(path: string, atime: number, mtime: number): Promise<void>;
61export function futimesAsync(fd: number, atime: number, mtime: number): Promise<void>;
62export function fsyncAsync(fd: number): Promise<void>;
63export function writeAsync(
64 fd: number,
65 buffer: Buffer,
66 offset: number,
67 length: number,
68 position: number,
69): Promise<[number, Buffer]>;
70export function readAsync(
71 fd: number,
72 buffer: Buffer,
73 offset: number,
74 length: number,
75 position: number,
76): Promise<[number, Buffer]>;
77export function readFileAsync(filename: string, options: string | ReadOptions): Promise<string>;
78export function readFileAsync(filename: string): Promise<Buffer>;
79export function writeFileAsync(filename: string, data: any, options?: string | WriteOptions): Promise<void>;
80export function mkdtempAsync(prefix: string, options: string | { encoding: string }): Promise<string>;
81export function appendFileAsync(filename: string, data: any, option?: string | WriteOptions): Promise<void>;
82
83export function existsAsync(path: string): Promise<boolean>;
84export function ensureDirAsync(path: string): Promise<void>;
85
86export function isDirectory(path: string, callback?: (err: Error, isDirectory: boolean) => void): void;
87export function isDirectorySync(path: string): boolean;
88export function isDirectoryAsync(path: string): Promise<boolean>;