Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NodeFS

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

  • new NodeFS(realFs?: typeof fs): NodeFS

Properties

pathUtils

pathUtils: PathUtils<PortablePath>

Private realFs

realFs: typeof fs

Methods

accessPromise

  • accessPromise(p: PortablePath, mode?: undefined | number): Promise<void>

accessSync

  • accessSync(p: PortablePath, mode?: undefined | number): void

appendFilePromise

appendFileSync

changeFilePromise

changeFileSync

chmodPromise

  • chmodPromise(p: PortablePath, mask: number): Promise<void>

chmodSync

chownPromise

  • chownPromise(p: PortablePath, uid: number, gid: number): Promise<void>

chownSync

  • chownSync(p: PortablePath, uid: number, gid: number): void

closePromise

  • closePromise(fd: number): Promise<void>

closeSync

  • closeSync(fd: number): void

copyFilePromise

copyFileSync

copyPromise

  • copyPromise(destination: PortablePath, source: PortablePath, options?: undefined | object): Promise<void>
  • copyPromise<P2>(destination: PortablePath, source: P2, options: object): Promise<void>

copySync

createReadStream

createWriteStream

existsPromise

existsSync

fchmodPromise

  • fchmodPromise(fd: number, mask: number): Promise<void>

fchmodSync

  • fchmodSync(fd: number, mask: number): void

fchownPromise

  • fchownPromise(fd: number, uid: number, gid: number): Promise<void>

fchownSync

  • fchownSync(fd: number, uid: number, gid: number): void

fstatPromise

  • fstatPromise(fd: number): Promise<Stats>
  • fstatPromise(fd: number, opts: object): Promise<BigIntStats>
  • fstatPromise(fd: number, opts?: undefined | object): Promise<BigIntStats | Stats>

fstatSync

  • fstatSync(fd: number): Stats
  • fstatSync(fd: number, opts: object): BigIntStats
  • fstatSync(fd: number, opts?: undefined | object): BigIntStats | Stats

ftruncatePromise

  • ftruncatePromise(fd: number, len?: undefined | number): Promise<void>

ftruncateSync

  • ftruncateSync(fd: number, len?: undefined | number): void

genTraversePromise

  • genTraversePromise(init: PortablePath, __namedParameters?: object): AsyncGenerator<P, void, unknown>

getExtractHint

  • getExtractHint(): boolean

getRealPath

  • getRealPath(): string & object

linkPromise

linkSync

lockPromise

  • lockPromise<T>(affectedPath: PortablePath, callback: function): Promise<T>

lstatPromise

lstatSync

Optional lutimesPromise

  • lutimesPromise(p: PortablePath, atime: Date | string | number, mtime: Date | string | number): Promise<void>

Private lutimesPromiseImpl

  • lutimesPromiseImpl(this: NodeFS, p: PortablePath, atime: Date | string | number, mtime: Date | string | number): Promise<void>

Optional lutimesSync

  • lutimesSync(p: PortablePath, atime: Date | string | number, mtime: Date | string | number): void

Private lutimesSyncImpl

  • lutimesSyncImpl(this: NodeFS, p: PortablePath, atime: Date | string | number, mtime: Date | string | number): void

Private makeCallback

  • makeCallback<T>(resolve: function, reject: function): (Anonymous function)

  • Type parameters

    • T

    Parameters

    • resolve: function
        • (value: T): void

        • Parameters

          • value: T

          Returns void

    • reject: function
        • (reject: ErrnoException): void

        • Parameters

          • reject: ErrnoException

          Returns void

    Returns (Anonymous function)

mkdirPromise

mkdirSync

mkdirpPromise

  • mkdirpPromise(p: PortablePath, __namedParameters?: object): Promise<string | undefined>

mkdirpSync

  • mkdirpSync(p: PortablePath, __namedParameters?: object): string | undefined

movePromise

moveSync

openPromise

  • openPromise(p: PortablePath, flags: string, mode?: undefined | number): Promise<number>

openSync

  • openSync(p: PortablePath, flags: string, mode?: undefined | number): number

opendirPromise

opendirSync

preserveTimePromise

  • preserveTimePromise(p: PortablePath, cb: function): Promise<void>

preserveTimeSync

  • preserveTimeSync(p: PortablePath, cb: function): Promise<void>

readFilePromise

readFileSync

readJsonPromise

readJsonSync

readPromise

  • readPromise(fd: number, buffer: Buffer, offset?: number, length?: number, position?: number | null): Promise<number>

readSync

  • readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number

readdirPromise

readdirSync

readlinkPromise

  • readlinkPromise(p: PortablePath): Promise<string & object>

readlinkSync

realpathPromise

  • realpathPromise(p: PortablePath): Promise<string & object>

realpathSync

removePromise

  • removePromise(p: PortablePath, __namedParameters?: object): Promise<void>

removeSync

  • removeSync(p: PortablePath, __namedParameters?: object): void

renamePromise

renameSync

resolve

rmdirPromise

rmdirSync

statPromise

statSync

symlinkPromise

symlinkSync

truncatePromise

  • truncatePromise(p: PortablePath, len?: undefined | number): Promise<void>

truncateSync

  • truncateSync(p: PortablePath, len?: undefined | number): void

unlinkPromise

unlinkSync

unwatchFile

utimesPromise

  • utimesPromise(p: PortablePath, atime: Date | string | number, mtime: Date | string | number): Promise<void>

utimesSync

  • utimesSync(p: PortablePath, atime: Date | string | number, mtime: Date | string | number): void

watch

watchFile

writeFilePromise

writeFileSync

writeJsonPromise

  • writeJsonPromise(p: PortablePath, data: any): Promise<void>

writeJsonSync

writePromise

  • writePromise(fd: number, buffer: Buffer, offset?: undefined | number, length?: undefined | number, position?: undefined | number): Promise<number>
  • writePromise(fd: number, buffer: string, position?: undefined | number): Promise<number>

writeSync

  • writeSync(fd: number, buffer: Buffer, offset?: undefined | number, length?: undefined | number, position?: undefined | number): number
  • writeSync(fd: number, buffer: string, position?: undefined | number): number

Generated using TypeDoc