Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NodePathFS

Adds support for file URLs and Buffers to the wrapped baseFs, but not inside the typings.

Only exists for compatibility with Node's behavior.

Automatically wraps all FS instances passed to patchFs & extendFs.

Don't use it!

Only exists for compatibility with Node's behavior.

Automatically wraps all FS instances passed to patchFs & extendFs.

Don't use it!

Hierarchy

Constructors

Properties

Methods

Constructors

constructor

Properties

Protected baseFs

baseFs: FakeFS<NativePath>

pathUtils

pathUtils: PathUtils<NativePath>

Methods

accessPromise

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

accessSync

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

appendFilePromise

appendFileSync

changeFilePromise

changeFileSync

checksumFilePromise

  • checksumFilePromise(path: NativePath, __namedParameters?: object): Promise<string>

chmodPromise

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

chmodSync

chownPromise

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

chownSync

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

closePromise

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

closeSync

  • closeSync(fd: number): void

copyFilePromise

copyFileSync

copyPromise

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

copySync

  • copySync(destination: NativePath, source: NativePath, options?: undefined | object): void
  • copySync<P2>(destination: NativePath, source: P2, options: object): void

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: NativePath, __namedParameters?: object): AsyncGenerator<P, void, unknown>

getExtractHint

getRealPath

  • getRealPath(): P

linkPromise

linkSync

lockPromise

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

lstatPromise

lstatSync

lutimesPromise

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

lutimesSync

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

Protected mapFromBase

Protected mapToBase

  • mapToBase(path: NativePath | URL | Buffer): string

mkdirPromise

mkdirSync

mkdirpPromise

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

mkdirpSync

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

movePromise

moveSync

openPromise

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

openSync

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

opendirPromise

opendirSync

preserveTimePromise

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

preserveTimeSync

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

readFilePromise

  • readFilePromise(p: FSPath<NativePath>, encoding?: undefined | null): Promise<Buffer>
  • readFilePromise(p: FSPath<NativePath>, encoding: BufferEncoding): Promise<string>
  • readFilePromise(p: FSPath<NativePath>, encoding?: BufferEncoding | null): Promise<Buffer | string>

readFileSync

readJsonPromise

readJsonSync

readPromise

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

readSync

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

readdirPromise

readdirSync

readlinkPromise

readlinkSync

realpathPromise

realpathSync

removePromise

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

removeSync

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

renamePromise

renameSync

resolve

rmdirPromise

rmdirSync

statPromise

statSync

symlinkPromise

symlinkSync

truncatePromise

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

truncateSync

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

unlinkPromise

unlinkSync

unwatchFile

utimesPromise

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

utimesSync

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

watch

watchFile

writeFilePromise

writeFileSync

writeJsonPromise

  • writeJsonPromise(p: NativePath, 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