UNPKG

1.25 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 /** Read an entire file into memory */
8 read(name: string): string
9 read(name: string, enc: null): Buffer
10 read(name: string, enc: string): any
11 /** Read and parse a .json file */
12 readJson(name: string): any
13 /** Get the array of filenames in a directory */
14 list(name: string): string[]
15 /** Resolve a symlink */
16 follow(name: string, recursive?: boolean): string
17 exists(name: string): boolean
18 isFile(name: string): boolean
19 isDir(name: string): boolean
20 /** Return true if given name is a symlink */
21 isLink(name: string): boolean
22 /** Create a file or update its mtime */
23 touch(name: string): void
24 /** Change the permissions of a file */
25 chmod(name: string, mode: number|string): void
26 /** Create a symlink */
27 link(name: string, target: string): void
28 /** Create or update a file */
29 write(name: string, content: string | Buffer): Promise<void>
30 /** Create a directory */
31 mkdir(name: string): void
32 /** Rename a path */
33 rename(src: string, dest: string): void
34 /** Destroy a path */
35 remove(name: string, recursive?: boolean): void
36} & ErrorCode
37export = saxon