UNPKG

1.43 kBTypeScriptView Raw
1import * as fs from 'fs'
2import { ErrorCode } from './errno'
3
4declare const saxon: {
5 /** Get the stats of a file */
6 stat(name: string): fs.Stats
7 lstat(name: string): fs.Stats
8 /** Read an entire file into memory */
9 read(name: string): string
10 read(name: string, enc: null): Buffer
11 read(name: string, enc: string): any
12 /** Read and parse a .json file */
13 readJson(name: string): any
14 /** Get file permissions like "0777" */
15 readPerms(name: string): string
16 /** Get the array of filenames in a directory */
17 list(name: string): string[]
18 /** Resolve a symlink */
19 follow(name: string, recursive?: boolean): string
20 exists(name: string): boolean
21 isFile(name: string): boolean
22 isDir(name: string): boolean
23 /** Return true if given name is a symlink */
24 isLink(name: string): boolean
25 /** Create a file or update its mtime */
26 touch(name: string): void
27 /** Change the permissions of a file */
28 chmod(name: string, mode: number|string): void
29 /** Create a symlink */
30 link(name: string, target: string): void
31 /** Create or update a file */
32 write(name: string, content: string | Buffer): Promise<void>
33 /** Create a directory */
34 mkdir(name: string): void
35 /** Rename a path */
36 rename(src: string, dest: string): void
37 /** Copy a file or directory */
38 copy(src: string, dest: string): void
39 /** Destroy a path */
40 remove(name: string, recursive?: boolean): void
41} & ErrorCode
42export = saxon