Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PosixFS

Hierarchy

Constructors

constructor

Properties

Protected baseFs

pathUtils

pathUtils: PathUtils<NativePath>

Static DEFAULT_TIME

DEFAULT_TIME: number = 315532800

Methods

accessPromise

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

accessSync

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

appendFilePromise

appendFileSync

changeFilePromise

changeFileSync

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

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

genTraversePromise

  • genTraversePromise(init: NativePath, __namedParameters?: object): AsyncGenerator<P extends undefined | null ? never : P, void, unknown>

getExtractHint

getRealPath

  • getRealPath(): P

linkPromise

linkSync

lockPromise

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

lstatPromise

  • lstatPromise(p: NativePath): Promise<Stats>
  • lstatPromise(p: NativePath, opts: object): Promise<BigIntStats>
  • lstatPromise(p: NativePath, opts?: undefined | object): Promise<BigIntStats | Stats>

lstatSync

  • lstatSync(p: NativePath): Stats
  • lstatSync(p: NativePath, opts: object): BigIntStats
  • lstatSync(p: NativePath, opts?: undefined | object): BigIntStats | Stats

Optional lutimesPromise

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

Optional lutimesSync

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

Protected mapFromBase

Protected mapToBase

mkdirPromise

mkdirSync

mkdirpPromise

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

mkdirpSync

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

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: "utf8"): Promise<string>
  • readFilePromise(p: FSPath<NativePath>, encoding?: undefined | string): Promise<Buffer>

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

  • statPromise(p: NativePath): Promise<Stats>
  • statPromise(p: NativePath, opts: object): Promise<BigIntStats>
  • statPromise(p: NativePath, opts?: undefined | object): Promise<BigIntStats | Stats>

statSync

  • statSync(p: NativePath): Stats
  • statSync(p: NativePath, opts: object): BigIntStats
  • statSync(p: NativePath, opts?: undefined | object): BigIntStats | Stats

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