Module "fs"

Index

Variables

fs

Functions

Variables

Let fs

Functions

appendFileSync

appendFileSync(...args: Parameters<fsObjType["appendFileSync"]>): any

- Defined in src/fs.ts:19
Parameters
- Rest ...args: Parameters<fsObjType["appendFileSync"]>
Returns any

chmodSync

chmodSync(...args: Parameters<fsObjType["chmodSync"]>): any

- Defined in src/fs.ts:57
Parameters
- Rest ...args: Parameters<fsObjType["chmodSync"]>
Returns any

closeSync

closeSync(...args: Parameters<fsObjType["closeSync"]>): any

- Defined in src/fs.ts:103
Parameters
- Rest ...args: Parameters<fsObjType["closeSync"]>
Returns any

copyFileSync

copyFileSync(...args: Parameters<fsObjType["copyFileSync"]>): any

- Defined in src/fs.ts:25
Parameters
- Rest ...args: Parameters<fsObjType["copyFileSync"]>
Returns any

existsSync

existsSync(...args: Parameters<fsObjType["existsSync"]>): any

- Defined in src/fs.ts:41
Parameters
- Rest ...args: Parameters<fsObjType["existsSync"]>
Returns any

getFs

getFs(): fsObjType

- Defined in src/fs.ts:15
Returns fsObjType

linkSync

linkSync(...args: Parameters<fsObjType["linkSync"]>): any

- Defined in src/fs.ts:107
Parameters
- Rest ...args: Parameters<fsObjType["linkSync"]>
Returns any

lstatSync

lstatSync(...args: Parameters<fsObjType["lstatSync"]>): any

- Defined in src/fs.ts:61
Parameters
- Rest ...args: Parameters<fsObjType["lstatSync"]>
Returns any

mkdirSync

mkdirSync(...args: Parameters<fsObjType["mkdirSync"]>): any

- Defined in src/fs.ts:75
Parameters
- Rest ...args: Parameters<fsObjType["mkdirSync"]>
Returns any

openSync

openSync(...args: Parameters<fsObjType["openSync"]>): any

- Defined in src/fs.ts:99
Parameters
- Rest ...args: Parameters<fsObjType["openSync"]>
Returns any

readFileSync

readFileSync(...args: Parameters<fsObjType["readFileSync"]>): any

- Defined in src/fs.ts:45
Parameters
- Rest ...args: Parameters<fsObjType["readFileSync"]>
Returns any

readdirSync

readdirSync(path: string): any

- Defined in src/fs.ts:79
Parameters
- path: string
Returns any

renameSync

renameSync(...args: Parameters<fsObjType["renameSync"]>): any

- Defined in src/fs.ts:49
Parameters
- Rest ...args: Parameters<fsObjType["renameSync"]>
Returns any

rmdirSync

rmdirSync(...args: Parameters<fsObjType["rmdirSync"]>): any

- Defined in src/fs.ts:83
Parameters
- Rest ...args: Parameters<fsObjType["rmdirSync"]>
Returns any

setFs

setFs(newFs: fsObjType): void

- Defined in src/fs.ts:11
this function allows you to override the fs module that fs-pro uses

note

the watch method must follow the "node-watch" package api not node fs

Parameters
- newFs: fsObjType
  
  the new fs
Returns void

statSync

statSync(path: string): Stats

- Defined in src/fs.ts:69
Parameters
- path: string
Returns Stats

symlinkSync

symlinkSync(...args: Parameters<fsObjType["linkSync"]>): any

- Defined in src/fs.ts:111
Parameters
- Rest ...args: Parameters<fsObjType["linkSync"]>
Returns any

tmpDir

tmpDir(): any

- Defined in src/fs.ts:95
Returns any

tmpFile

tmpFile(): any

- Defined in src/fs.ts:91
Returns any

truncateSync

truncateSync(...args: Parameters<fsObjType["truncateSync"]>): any

- Defined in src/fs.ts:115
Parameters
- Rest ...args: Parameters<fsObjType["truncateSync"]>
Returns any

unlinkSync

unlinkSync(...args: Parameters<fsObjType["unlinkSync"]>): any

- Defined in src/fs.ts:65
Parameters
- Rest ...args: Parameters<fsObjType["unlinkSync"]>
Returns any

watch

watch(...args: Parameters<fsObjType["watch"]>): any

- Defined in src/fs.ts:87
Parameters
- Rest ...args: Parameters<fsObjType["watch"]>
Returns any

writeFileSync

writeFileSync(...args: Parameters<fsObjType["writeFileSync"]>): any

- Defined in src/fs.ts:53
Parameters
- Rest ...args: Parameters<fsObjType["writeFileSync"]>
Returns any

Generated using TypeDoc