Class BaseFileSystem

Basic filesystem class. Most filesystems should extend this class, as it provides default implementations for a handful of methods.

Hierarchy

BaseFileSystem

Index

Methods

appendFile

appendFile(fname: string, data: any, encoding: string | null, flag: FileFlag, mode: number, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:689
Parameters
- fname: string
- data: any
- encoding: string | null
- flag: FileFlag
- mode: number
- cb: BFSOneArgCallback
Returns void

appendFileSync

appendFileSync(fname: string, data: any, encoding: string | null, flag: FileFlag, mode: number): void

- Defined in core/file_system.ts:707
Parameters
- fname: string
- data: any
- encoding: string | null
- flag: FileFlag
- mode: number
Returns void

chmod

chmod(p: string, isLchmod: boolean, mode: number, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:718
Parameters
- p: string
- isLchmod: boolean
- mode: number
- cb: BFSOneArgCallback
Returns void

chmodSync

chmodSync(p: string, isLchmod: boolean, mode: number): void

- Defined in core/file_system.ts:721
Parameters
- p: string
- isLchmod: boolean
- mode: number
Returns void

chown

chown(p: string, isLchown: boolean, uid: number, gid: number, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:724
Parameters
- p: string
- isLchown: boolean
- uid: number
- gid: number
- cb: BFSOneArgCallback
Returns void

chownSync

chownSync(p: string, isLchown: boolean, uid: number, gid: number): void

- Defined in core/file_system.ts:727
Parameters
- p: string
- isLchown: boolean
- uid: number
- gid: number
Returns void

createFile

createFile(p: string, flag: FileFlag, mode: number, cb: BFSCallback): void

- Defined in core/file_system.ts:366
Create the file at path p with the given mode. Then, open it with the given flag.

Parameters
- p: string
- flag: FileFlag
- mode: number
- cb: BFSCallback
Returns void

createFileSync

createFileSync(p: string, flag: FileFlag, mode: number): File

- Defined in core/file_system.ts:450
Create the file at path p with the given mode. Then, open it with the given flag.

Parameters
- p: string
- flag: FileFlag
- mode: number
Returns File

diskSpace

diskSpace(p: string, cb: function): void

- Defined in core/file_system.ts:351
Parameters
- p: string
- cb: function
  - - (total: number, free: number): any
    - Parameters
      - total: number
      - free: number
      Returns any
Returns void

exists

exists(p: string, cb: function): void

- Defined in core/file_system.ts:520
Parameters
- p: string
- cb: function
  - - (exists: boolean): void
    - Parameters
      - exists: boolean
      Returns void
Returns void

existsSync

existsSync(p: string): boolean

- Defined in core/file_system.ts:525
Parameters
- p: string
Returns boolean

link

link(srcpath: string, dstpath: string, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:736
Parameters
- srcpath: string
- dstpath: string
- cb: BFSOneArgCallback
Returns void

linkSync

linkSync(srcpath: string, dstpath: string): void

- Defined in core/file_system.ts:739
Parameters
- srcpath: string
- dstpath: string
Returns void

mkdir

mkdir(p: string, mode: number, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:508
Parameters
- p: string
- mode: number
- cb: BFSOneArgCallback
Returns void

mkdirSync

mkdirSync(p: string, mode: number): void

- Defined in core/file_system.ts:511
Parameters
- p: string
- mode: number
Returns void

open

open(p: string, flag: FileFlag, mode: number, cb: BFSCallback): void

- Defined in core/file_system.ts:369
Parameters
- p: string
- flag: FileFlag
- mode: number
- cb: BFSCallback
Returns void

openFile

openFile(p: string, flag: FileFlag, cb: BFSCallback): void

- Defined in core/file_system.ts:359
Opens the file at path p with the given flag. The file must exist.

Parameters
- p: string
  
  The path to open.
- flag: FileFlag
  
  The flag to use when opening the file.
- cb: BFSCallback
Returns void

openFileSync

openFileSync(p: string, flag: FileFlag, mode: number): File

- Defined in core/file_system.ts:443
Opens the file at path p with the given flag. The file must exist.

Parameters
- p: string
  
  The path to open.
- flag: FileFlag
  
  The flag to use when opening the file.
- mode: number
Returns File

A File object corresponding to the opened file.

openSync

openSync(p: string, flag: FileFlag, mode: number): File

- Defined in core/file_system.ts:453
Parameters
- p: string
- flag: FileFlag
- mode: number
Returns File

readFile

readFile(fname: string, encoding: string | null, flag: FileFlag, cb: BFSCallback): void

- Defined in core/file_system.ts:597
Parameters
- fname: string
- encoding: string | null
- flag: FileFlag
- cb: BFSCallback
Returns void

readFileSync

readFileSync(fname: string, encoding: string | null, flag: FileFlag): any

- Defined in core/file_system.ts:634
Parameters
- fname: string
- encoding: string | null
- flag: FileFlag
Returns any

readdir

readdir(p: string, cb: BFSCallback): void

- Defined in core/file_system.ts:514
Parameters
- p: string
- cb: BFSCallback
Returns void

readdirSync

readdirSync(p: string): string[]

- Defined in core/file_system.ts:517
Parameters
- p: string
Returns string[]

readlink

readlink(p: string, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:748
Parameters
- p: string
- cb: BFSOneArgCallback
Returns void

readlinkSync

readlinkSync(p: string): string

- Defined in core/file_system.ts:751
Parameters
- p: string
Returns string

realpath

realpath(p: string, cache: object, cb: BFSCallback): void

- Defined in core/file_system.ts:533
Parameters
- p: string
- cache: object
  - [path: string]: string
- cb: BFSCallback
Returns void

realpathSync

realpathSync(p: string, cache: object): string

- Defined in core/file_system.ts:554
Parameters
- p: string
- cache: object
  - [path: string]: string
Returns string

rename

rename(oldPath: string, newPath: string, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:425
Parameters
- oldPath: string
- newPath: string
- cb: BFSOneArgCallback
Returns void

renameSync

renameSync(oldPath: string, newPath: string): void

- Defined in core/file_system.ts:428
Parameters
- oldPath: string
- newPath: string
Returns void

rmdir

rmdir(p: string, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:502
Parameters
- p: string
- cb: BFSOneArgCallback
Returns void

rmdirSync

rmdirSync(p: string): void

- Defined in core/file_system.ts:505
Parameters
- p: string
Returns void

stat

stat(p: string, isLstat: boolean | null, cb: BFSCallback): void

- Defined in core/file_system.ts:431
Parameters
- p: string
- isLstat: boolean | null
- cb: BFSCallback
Returns void

statSync

statSync(p: string, isLstat: boolean | null): Stats

- Defined in core/file_system.ts:434
Parameters
- p: string
- isLstat: boolean | null
Returns Stats

supportsLinks

supportsLinks(): boolean

- Defined in core/file_system.ts:348
Returns boolean

symlink

symlink(srcpath: string, dstpath: string, type: string, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:742
Parameters
- srcpath: string
- dstpath: string
- type: string
- cb: BFSOneArgCallback
Returns void

symlinkSync

symlinkSync(srcpath: string, dstpath: string, type: string): void

- Defined in core/file_system.ts:745
Parameters
- srcpath: string
- dstpath: string
- type: string
Returns void

truncate

truncate(p: string, len: number, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:574
Parameters
- p: string
- len: number
- cb: BFSOneArgCallback
Returns void

truncateSync

truncateSync(p: string, len: number): void

- Defined in core/file_system.ts:586
Parameters
- p: string
- len: number
Returns void

unlink

unlink(p: string, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:496
Parameters
- p: string
- cb: BFSOneArgCallback
Returns void

unlinkSync

unlinkSync(p: string): void

- Defined in core/file_system.ts:499
Parameters
- p: string
Returns void

utimes

utimes(p: string, atime: Date, mtime: Date, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:730
Parameters
- p: string
- atime: Date
- mtime: Date
- cb: BFSOneArgCallback
Returns void

utimesSync

utimesSync(p: string, atime: Date, mtime: Date): void

- Defined in core/file_system.ts:733
Parameters
- p: string
- atime: Date
- mtime: Date
Returns void

writeFile

writeFile(fname: string, data: any, encoding: string | null, flag: FileFlag, mode: number, cb: BFSOneArgCallback): void

- Defined in core/file_system.ts:651
Parameters
- fname: string
- data: any
- encoding: string | null
- flag: FileFlag
- mode: number
- cb: BFSOneArgCallback
Returns void

writeFileSync

writeFileSync(fname: string, data: any, encoding: string | null, flag: FileFlag, mode: number): void

- Defined in core/file_system.ts:676
Parameters
- fname: string
- data: any
- encoding: string | null
- flag: FileFlag
- mode: number
Returns void

Generated using TypeDoc