index.d.ts 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216
  1. import { Stats, WriteStream } from "fs"
  2. export { WriteStream, createReadStream, createWriteStream, FSWatcher, Stats } from "fs"
  3. export type Filter = (file: string, stat: Stats) => boolean
  4. export interface CopyOptions {
  5. overwrite?: boolean
  6. dereference?: boolean
  7. filter?: RegExp | ((file: string, stat: Stats) => boolean)
  8. passStats?: boolean
  9. }
  10. export interface MoveOptions {
  11. overwrite?: boolean
  12. limit?: number
  13. }
  14. export function copy(src: string, dest: string, options?: CopyOptions): Promise<void>
  15. export function copyFile(src: string, dest: string): Promise<void>
  16. export function move(src: string, dest: string, options?: MoveOptions): Promise<void>
  17. export function moveSync(src: string, dest: string, options?: MoveOptions): void
  18. export function ensureFile(path: string): Promise<void>
  19. export function ensureFileSync(path: string): void
  20. export function createFile(file: string): Promise<void>
  21. export function createFileSync(file: string): void
  22. export function mkdirs(dir: string, options?: CreateDirOptions): Promise<void>
  23. export function mkdirsSync(dir: string, options?: CreateDirOptions): void
  24. export function mkdirp(dir: string, options?: CreateDirOptions): Promise<void>
  25. export function mkdirpSync(dir: string, options?: CreateDirOptions): void
  26. export function outputFile(file: string, data: any, options?: OpenOptions): Promise<void>
  27. export function outputFileSync(file: string, data: any): void
  28. export function outputJson(file: string, data: any, options?: JsonOptions): Promise<void>
  29. export function outputJsonSync(file: string, data: any): void
  30. export function readJson(file: string, options?: OpenOptions): Promise<any>
  31. export function readJsonSync(file: string, options?: OpenOptions): any
  32. export function remove(dir: string): Promise<void>
  33. export function removeSync(dir: string): void
  34. interface JsonOptions extends OpenOptions {
  35. spaces: number
  36. }
  37. export function writeJson(file: string, object: any, options?: JsonOptions): Promise<void>
  38. export function rename(oldPath: string, newPath: string): Promise<void>
  39. export function truncate(fd: number, len: number): Promise<void>
  40. export function truncateSync(fd: number, len: number): void
  41. export function chown(path: string, uid: number, gid: number): Promise<void>
  42. export function chownSync(path: string, uid: number, gid: number): void
  43. export function fchown(fd: number, uid: number, gid: number): Promise<void>
  44. export function fchownSync(fd: number, uid: number, gid: number): void
  45. export function lchown(path: string, uid: number, gid: number): Promise<void>
  46. export function lchownSync(path: string, uid: number, gid: number): void
  47. export function chmod(path: string, mode: string | number): Promise<void>
  48. export function chmodSync(path: string, mode: string | number): void
  49. export function fchmod(fd: number, mode: string | number): Promise<void>
  50. export function fchmodSync(fd: number, mode: string | number): void
  51. export function lchmod(path: string, mode: string | number): Promise<void>
  52. export function lchmodSync(path: string, mode: string | number): void
  53. export function stat(path: string): Promise<Stats>
  54. export function statSync(path: string): Stats
  55. export function lstat(path: string): Promise<Stats>
  56. export function lstatSync(path: string): Stats
  57. export function fstat(fd: number): Promise<Stats>
  58. export function fstatSync(fd: number): Stats
  59. export function link(srcpath: string, dstpath: string): Promise<void>
  60. export function linkSync(srcpath: string, dstpath: string): void
  61. export function symlink(srcpath: string, dstpath: string, type?: string): Promise<void>
  62. export function symlinkSync(srcpath: string, dstpath: string, type?: string): void
  63. export function readlink(path: string): Promise<string>
  64. export function realpath(path: string): Promise<string>
  65. export function realpath(path: string, cache: string): Promise<string>
  66. export function realpathSync(path: string, cache?: boolean): string
  67. export function unlink(path: string): Promise<string>
  68. export function unlinkSync(path: string): void
  69. export function rmdir(path: string): Promise<void>
  70. export function rmdirSync(path: string): void
  71. export function mkdir(path: string, mode?: string | number): Promise<void>
  72. export function mkdirSync(path: string, mode?: string | number): void
  73. export function mkdtemp(prefix: string): Promise<string>
  74. export function readdir(path: string): Promise<string[]>
  75. export function close(fd: number): Promise<void>
  76. export function closeSync(fd: number): void
  77. export function open(path: string, flags: string, mode?: string): Promise<number>
  78. export function openSync(path: string, flags: string, mode?: string): number
  79. export function utimes(path: string, atime: number, mtime: number): Promise<void>
  80. export function utimesSync(path: string, atime: number, mtime: number): void
  81. export function futimes(fd: number, atime: number, mtime: number): Promise<void>
  82. export function futimesSync(fd: number, atime: number, mtime: number): void
  83. export function fsync(fd: number): Promise<void>
  84. export function fsyncSync(fd: number): void
  85. export function write(fd: number, buffer: Buffer, offset?: number, length?: number, position?: number, callback?: (err: Error, written: number, buffer: Buffer) => void): Promise<number>
  86. export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number
  87. export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: Error, bytesRead: number, buffer: Buffer) => void): Promise<number>
  88. export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number
  89. export function readFile(filename: string, encoding: string): Promise<string>
  90. export function readFile(filename: string, options: OpenOptions): Promise<string>
  91. export function readFile(filename: string): Promise<Buffer>
  92. export function readFileSync(filename: string): Buffer
  93. export function readFileSync(filename: string, encoding: string): string
  94. export function readFileSync(filename: string, options: OpenOptions): string
  95. export function writeFile(filename: string, data: any, encoding?: string): Promise<void>
  96. export function writeFile(filename: string, data: any, options?: OpenOptions): Promise<void>
  97. export function writeFileSync(filename: string, data: any, encoding?: string): void
  98. export function writeFileSync(filename: string, data: any, option?: OpenOptions): void
  99. export function appendFile(filename: string, data: any, encoding?: string): Promise<void>
  100. export function appendFile(filename: string, data: any, option?: OpenOptions): Promise<void>
  101. export function appendFileSync(filename: string, data: any, encoding?: string): void
  102. export function appendFileSync(filename: string, data: any, option?: OpenOptions): void
  103. export function ensureDir(path: string, options?: CreateDirOptions): Promise<void>
  104. export function ensureDirSync(path: string): void
  105. export function ensureLink(path: string): Promise<void>
  106. export function ensureLinkSync(path: string): void
  107. export function ensureSymlink(path: string): Promise<void>
  108. export function ensureSymlinkSync(path: string): void
  109. export function emptyDir(path: string): Promise<void>
  110. export function emptyDirSync(path: string): boolean
  111. export function pathExists(path: string): Promise<boolean>
  112. export function access(path: string | Buffer, mode?: number): Promise<void>
  113. export function deleteFile(path: string, ignoreIfNotExists?: boolean): Promise<any>
  114. export interface OpenOptions {
  115. encoding?: string
  116. flag?: string
  117. mode?: number | string
  118. }
  119. export interface CreateDirOptions {
  120. fs?: any
  121. mode?: number | string
  122. }