Options
All
  • Public
  • Public/Protected
  • All
Menu

External module "node_modules/@types/fs-extra/index.d"

Index

Type aliases

CopyFilterAsync

CopyFilterAsync: function

Type declaration

    • (src: string, dest: string): Promise<boolean>
    • Parameters

      • src: string
      • dest: string

      Returns Promise<boolean>

CopyFilterSync

CopyFilterSync: function

Type declaration

    • (src: string, dest: string): boolean
    • Parameters

      • src: string
      • dest: string

      Returns boolean

FsSymlinkType

FsSymlinkType: "dir" | "file" | "junction"

SymlinkType

SymlinkType: "dir" | "file"

Functions

access

  • access(path: string | Buffer, callback: function): void
  • access(path: string | Buffer, mode: number, callback: function): void
  • access(path: string | Buffer, mode?: undefined | number): Promise<void>
  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • Optional mode: undefined | number

    Returns Promise<void>

appendFile

  • appendFile(file: string | Buffer | number, data: any, options: object, callback: function): void
  • appendFile(file: string | Buffer | number, data: any, callback: function): void
  • appendFile(file: string | Buffer | number, data: any, options?: undefined | object): Promise<void>
  • Parameters

    • file: string | Buffer | number
    • data: any
    • options: object
      • Optional encoding?: undefined | string
      • Optional flag?: undefined | string
      • Optional mode?: number | string
    • callback: function

    Returns void

  • Parameters

    Returns void

  • Parameters

    • file: string | Buffer | number
    • data: any
    • Optional options: undefined | object

    Returns Promise<void>

chmod

  • chmod(path: string | Buffer, mode: string | number, callback: function): void
  • chmod(path: string | Buffer, mode: string | number): Promise<void>
  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • mode: string | number

    Returns Promise<void>

chown

  • chown(path: string | Buffer, uid: number, gid: number): Promise<void>
  • chown(path: string | Buffer, uid: number, gid: number, callback: function): void
  • Parameters

    • path: string | Buffer
    • uid: number
    • gid: number

    Returns Promise<void>

  • Parameters

    Returns void

close

  • close(fd: number, callback: function): void
  • close(fd: number): Promise<void>
  • Parameters

    Returns void

  • Parameters

    • fd: number

    Returns Promise<void>

copy

  • copy(src: string, dest: string, options?: CopyOptions): Promise<void>
  • copy(src: string, dest: string, callback: function): void
  • copy(src: string, dest: string, options: CopyOptions, callback: function): void
  • Parameters

    • src: string
    • dest: string
    • Optional options: CopyOptions

    Returns Promise<void>

  • Parameters

    • src: string
    • dest: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Parameters

    • src: string
    • dest: string
    • options: CopyOptions
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

copySync

  • Parameters

    Returns void

createFile

  • createFile(file: string): Promise<void>
  • createFile(file: string, callback: function): void
  • Parameters

    • file: string

    Returns Promise<void>

  • Parameters

    • file: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

createFileSync

  • createFileSync(file: string): void
  • Parameters

    • file: string

    Returns void

emptyDir

  • emptyDir(path: string): Promise<void>
  • emptyDir(path: string, callback: function): void
  • Parameters

    • path: string

    Returns Promise<void>

  • Parameters

    • path: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

emptyDirSync

  • emptyDirSync(path: string): void
  • Parameters

    • path: string

    Returns void

ensureDir

  • ensureDir(path: string): Promise<void>
  • ensureDir(path: string, callback: function): void
  • Parameters

    • path: string

    Returns Promise<void>

  • Parameters

    • path: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

ensureDirSync

  • ensureDirSync(path: string): void
  • Parameters

    • path: string

    Returns void

ensureFile

  • ensureFile(path: string): Promise<void>
  • ensureFile(path: string, callback: function): void
  • Parameters

    • path: string

    Returns Promise<void>

  • Parameters

    • path: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

ensureFileSync

  • ensureFileSync(path: string): void
  • Parameters

    • path: string

    Returns void

ensureLink

  • ensureLink(src: string, dest: string): Promise<void>
  • ensureLink(src: string, dest: string, callback: function): void
  • Parameters

    • src: string
    • dest: string

    Returns Promise<void>

  • Parameters

    • src: string
    • dest: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

ensureLinkSync

  • ensureLinkSync(src: string, dest: string): void
  • Parameters

    • src: string
    • dest: string

    Returns void

ensureSymlink

  • ensureSymlink(src: string, dest: string, type?: SymlinkType): Promise<void>
  • ensureSymlink(src: string, dest: string, type: SymlinkType, callback: function): void
  • ensureSymlink(src: string, dest: string, callback: function): void
  • Parameters

    Returns Promise<void>

  • Parameters

    • src: string
    • dest: string
    • type: SymlinkType
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Parameters

    • src: string
    • dest: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

ensureSymlinkSync

  • ensureSymlinkSync(src: string, dest: string, type?: SymlinkType): void
  • Parameters

    Returns void

fchmod

  • fchmod(fd: number, mode: string | number, callback: function): void
  • fchmod(fd: number, mode: string | number): Promise<void>
  • Parameters

    Returns void

  • Parameters

    • fd: number
    • mode: string | number

    Returns Promise<void>

fchown

  • fchown(fd: number, uid: number, gid: number, callback: function): void
  • fchown(fd: number, uid: number, gid: number): Promise<void>
  • Parameters

    Returns void

  • Parameters

    • fd: number
    • uid: number
    • gid: number

    Returns Promise<void>

fdatasync

  • fdatasync(fd: number, callback: function): void
  • fdatasync(fd: number): Promise<void>
  • Parameters

    • fd: number
    • callback: function
        • (): void
        • Returns void

    Returns void

  • Parameters

    • fd: number

    Returns Promise<void>

fstat

  • fstat(fd: number, callback: function): void
  • fstat(fd: number): Promise<Stats>
  • Parameters

    Returns void

  • Parameters

    • fd: number

    Returns Promise<Stats>

fsync

  • fsync(fd: number, callback: function): void
  • fsync(fd: number): Promise<void>
  • Parameters

    Returns void

  • Parameters

    • fd: number

    Returns Promise<void>

ftruncate

  • ftruncate(fd: number, callback: function): void
  • ftruncate(fd: number, len: number, callback: function): void
  • ftruncate(fd: number, len?: undefined | number): Promise<void>
  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • Optional len: undefined | number

    Returns Promise<void>

futimes

  • futimes(fd: number, atime: number, mtime: number, callback: function): void
  • futimes(fd: number, atime: Date, mtime: Date, callback: function): void
  • futimes(fd: number, atime: number, mtime: number): Promise<void>
  • futimes(fd: number, atime: Date, mtime: Date): Promise<void>
  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • atime: number
    • mtime: number

    Returns Promise<void>

  • Parameters

    • fd: number
    • atime: Date
    • mtime: Date

    Returns Promise<void>

lchown

  • lchown(path: string | Buffer, uid: number, gid: number, callback: function): void
  • lchown(path: string | Buffer, uid: number, gid: number): Promise<void>
  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • uid: number
    • gid: number

    Returns Promise<void>

link

  • link(srcpath: string | Buffer, dstpath: string | Buffer, callback: function): void
  • link(srcpath: string | Buffer, dstpath: string | Buffer): Promise<void>
  • Parameters

    Returns void

  • Parameters

    Returns Promise<void>

lstat

  • lstat(path: string | Buffer, callback: function): void
  • lstat(path: string | Buffer): Promise<Stats>
  • Parameters

    Returns void

  • Parameters

    Returns Promise<Stats>

mkdir

  • mkdir(path: string | Buffer, callback: function): void
  • mkdir(path: string | Buffer, mode: number | string, callback: function): void
  • mkdir(path: string | Buffer): Promise<void>
  • Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.

    Parameters

    • path: string | Buffer
    • callback: function

      No arguments other than a possible exception are given to the completion callback.

    Returns void

  • Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777.

    Parameters

    • path: string | Buffer
    • mode: number | string
    • callback: function

      No arguments other than a possible exception are given to the completion callback.

    Returns void

  • Parameters

    Returns Promise<void>

mkdirp

  • mkdirp(dir: string): Promise<void>
  • mkdirp(dir: string, callback: function): void
  • Parameters

    • dir: string

    Returns Promise<void>

  • Parameters

    • dir: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

mkdirpSync

  • mkdirpSync(dir: string): void
  • Parameters

    • dir: string

    Returns void

mkdirs

  • mkdirs(dir: string): Promise<void>
  • mkdirs(dir: string, callback: function): void
  • Parameters

    • dir: string

    Returns Promise<void>

  • Parameters

    • dir: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

mkdirsSync

  • mkdirsSync(dir: string): void
  • Parameters

    • dir: string

    Returns void

mkdtemp

  • mkdtemp(prefix: string): Promise<string>
  • mkdtemp(prefix: string, callback: function): void
  • Asynchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory.

    Parameters

    • prefix: string

    Returns Promise<string>

  • Parameters

    Returns void

move

  • move(src: string, dest: string, options?: MoveOptions): Promise<void>
  • move(src: string, dest: string, callback: function): void
  • move(src: string, dest: string, options: MoveOptions, callback: function): void
  • Parameters

    • src: string
    • dest: string
    • Optional options: MoveOptions

    Returns Promise<void>

  • Parameters

    • src: string
    • dest: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Parameters

    • src: string
    • dest: string
    • options: MoveOptions
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

moveSync

  • moveSync(src: string, dest: string, options?: MoveOptions): void
  • Parameters

    • src: string
    • dest: string
    • Optional options: MoveOptions

    Returns void

open

  • open(path: string | Buffer, flags: string | number, callback: function): void
  • open(path: string | Buffer, flags: string | number, mode: number, callback: function): void
  • open(path: string | Buffer, flags: string | number, mode?: undefined | number): Promise<number>
  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • flags: string | number
    • mode: number
    • callback: function

    Returns void

  • Parameters

    • path: string | Buffer
    • flags: string | number
    • Optional mode: undefined | number

    Returns Promise<number>

outputFile

  • outputFile(file: string, data: any, options?: WriteFileOptions | string): Promise<void>
  • outputFile(file: string, data: any, callback: function): void
  • outputFile(file: string, data: any, options: WriteFileOptions | string, callback: function): void
  • Parameters

    Returns Promise<void>

  • Parameters

    • file: string
    • data: any
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Parameters

    • file: string
    • data: any
    • options: WriteFileOptions | string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

outputFileSync

  • outputFileSync(file: string, data: any, options?: WriteFileOptions | string): void
  • Parameters

    Returns void

outputJSON

  • outputJSON(file: string, data: any, options?: WriteOptions): Promise<void>
  • outputJSON(file: string, data: any, options: WriteOptions, callback: function): void
  • outputJSON(file: string, data: any, callback: function): void
  • Parameters

    Returns Promise<void>

  • Parameters

    • file: string
    • data: any
    • options: WriteOptions
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Parameters

    • file: string
    • data: any
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

outputJSONSync

  • outputJSONSync(file: string, data: any, options?: WriteOptions): void
  • Parameters

    Returns void

outputJson

  • outputJson(file: string, data: any, options?: WriteOptions): Promise<void>
  • outputJson(file: string, data: any, options: WriteOptions, callback: function): void
  • outputJson(file: string, data: any, callback: function): void
  • Parameters

    Returns Promise<void>

  • Parameters

    • file: string
    • data: any
    • options: WriteOptions
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Parameters

    • file: string
    • data: any
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

outputJsonSync

  • outputJsonSync(file: string, data: any, options?: WriteOptions): void
  • Parameters

    Returns void

pathExists

  • pathExists(path: string): Promise<boolean>
  • pathExists(path: string, callback: function): void
  • Parameters

    • path: string

    Returns Promise<boolean>

  • Parameters

    • path: string
    • callback: function
        • (err: Error, exists: boolean): void
        • Parameters

          • err: Error
          • exists: boolean

          Returns void

    Returns void

pathExistsSync

  • pathExistsSync(path: string): boolean
  • Parameters

    • path: string

    Returns boolean

read

  • read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback: function): void
  • read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null): Promise<ReadResult>
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number | null
    • callback: function

    Returns void

  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number | null

    Returns Promise<ReadResult>

readFile

  • readFile(file: string | Buffer | number, callback: function): void
  • readFile(file: string | Buffer | number, encoding: string, callback: function): void
  • readFile(file: string | Buffer | number, options: object | object, callback: function): void
  • readFile(file: string | Buffer | number, options: object | object): Promise<string>
  • readFile(file: string | Buffer | number, encoding: string): Promise<string>
  • readFile(file: string | Buffer | number): Promise<Buffer>
  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • file: string | Buffer | number
    • options: object | object

    Returns Promise<string>

  • Parameters

    • file: string | Buffer | number
    • encoding: string

    Returns Promise<string>

  • Parameters

    • file: string | Buffer | number

    Returns Promise<Buffer>

readJSON

  • readJSON(file: string, options?: ReadOptions): Promise<any>
  • readJSON(file: string, callback: function): void
  • readJSON(file: string, options: ReadOptions, callback: function): void
  • Parameters

    Returns Promise<any>

  • Parameters

    • file: string
    • callback: function
        • (err: Error, jsonObject: any): void
        • Parameters

          • err: Error
          • jsonObject: any

          Returns void

    Returns void

  • Parameters

    • file: string
    • options: ReadOptions
    • callback: function
        • (err: Error, jsonObject: any): void
        • Parameters

          • err: Error
          • jsonObject: any

          Returns void

    Returns void

readJSONSync

  • readJSONSync(file: string, options?: ReadOptions): any
  • Parameters

    Returns any

readJson

  • readJson(file: string, options?: ReadOptions): Promise<any>
  • readJson(file: string, callback: function): void
  • readJson(file: string, options: ReadOptions, callback: function): void
  • Parameters

    Returns Promise<any>

  • Parameters

    • file: string
    • callback: function
        • (err: Error, jsonObject: any): void
        • Parameters

          • err: Error
          • jsonObject: any

          Returns void

    Returns void

  • Parameters

    • file: string
    • options: ReadOptions
    • callback: function
        • (err: Error, jsonObject: any): void
        • Parameters

          • err: Error
          • jsonObject: any

          Returns void

    Returns void

readJsonSync

  • readJsonSync(file: string, options?: ReadOptions): any
  • Parameters

    Returns any

readdir

  • readdir(path: string | Buffer, callback: function): void
  • readdir(path: string | Buffer): Promise<string[]>
  • Parameters

    Returns void

  • Parameters

    Returns Promise<string[]>

readlink

  • readlink(path: string | Buffer, callback: function): void
  • readlink(path: string | Buffer): Promise<string>
  • Parameters

    Returns void

  • Parameters

    Returns Promise<string>

realpath

  • realpath(path: string | Buffer, callback: function): void
  • realpath(path: string | Buffer, cache: object, callback: function): void
  • realpath(path: string | Buffer, cache?: undefined | object): Promise<string>
  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • cache: object
      • [path: string]: string
    • callback: function

    Returns void

  • Parameters

    • path: string | Buffer
    • Optional cache: undefined | object

    Returns Promise<string>

remove

  • remove(dir: string): Promise<void>
  • remove(dir: string, callback: function): void
  • Parameters

    • dir: string

    Returns Promise<void>

  • Parameters

    • dir: string
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

removeSync

  • removeSync(dir: string): void
  • Parameters

    • dir: string

    Returns void

rename

  • rename(oldPath: string, newPath: string, callback: function): void
  • rename(oldPath: string, newPath: string): Promise<void>
  • Parameters

    Returns void

  • Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

rmdir

  • rmdir(path: string | Buffer, callback: function): void
  • rmdir(path: string | Buffer): Promise<void>
  • Asynchronous rmdir - removes the directory specified in {path}

    Parameters

    • path: string | Buffer
    • callback: function

      No arguments other than a possible exception are given to the completion callback.

    Returns void

  • Parameters

    Returns Promise<void>

stat

  • stat(path: string | Buffer, callback: function): void
  • stat(path: string | Buffer): Promise<Stats>
  • Parameters

    Returns void

  • Parameters

    Returns Promise<Stats>

symlink

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    Returns Promise<void>

truncate

  • truncate(path: string | Buffer, callback: function): void
  • truncate(path: string | Buffer, len: number, callback: function): void
  • truncate(path: string | Buffer, len?: undefined | number): Promise<void>
  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • Optional len: undefined | number

    Returns Promise<void>

unlink

  • unlink(path: string | Buffer, callback: function): void
  • unlink(path: string | Buffer): Promise<void>
  • Asynchronous unlink - deletes the file specified in {path}

    Parameters

    • path: string | Buffer
    • callback: function

      No arguments other than a possible exception are given to the completion callback.

    Returns void

  • Parameters

    Returns Promise<void>

utimes

  • utimes(path: string | Buffer, atime: number, mtime: number, callback: function): void
  • utimes(path: string | Buffer, atime: Date, mtime: Date, callback: function): void
  • utimes(path: string | Buffer, atime: number, mtime: number): Promise<void>
  • utimes(path: string | Buffer, atime: Date, mtime: Date): Promise<void>
  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • path: string | Buffer
    • atime: number
    • mtime: number

    Returns Promise<void>

  • Parameters

    • path: string | Buffer
    • atime: Date
    • mtime: Date

    Returns Promise<void>

write

  • write(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback: function): void
  • write(fd: number, buffer: Buffer, offset: number, length: number, callback: function): void
  • write(fd: number, data: any, callback: function): void
  • write(fd: number, data: any, offset: number, callback: function): void
  • write(fd: number, data: any, offset: number, encoding: string, callback: function): void
  • write(fd: number, buffer: Buffer, offset: number, length: number, position?: number | null): Promise<WriteResult>
  • write(fd: number, data: any, offset: number, encoding?: undefined | string): Promise<WriteResult>
  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • position: number | null
    • callback: function

    Returns void

  • Parameters

    Returns void

  • Parameters

    • fd: number
    • data: any
    • callback: function

    Returns void

  • Parameters

    • fd: number
    • data: any
    • offset: number
    • callback: function

    Returns void

  • Parameters

    • fd: number
    • data: any
    • offset: number
    • encoding: string
    • callback: function

    Returns void

  • Parameters

    • fd: number
    • buffer: Buffer
    • offset: number
    • length: number
    • Optional position: number | null

    Returns Promise<WriteResult>

  • Parameters

    • fd: number
    • data: any
    • offset: number
    • Optional encoding: undefined | string

    Returns Promise<WriteResult>

writeFile

  • writeFile(file: string | Buffer | number, data: any, callback: function): void
  • writeFile(file: string | Buffer | number, data: any, options?: WriteFileOptions | string): Promise<void>
  • writeFile(file: string | Buffer | number, data: any, options: WriteFileOptions | string, callback: function): void
  • Parameters

    Returns void

  • Parameters

    Returns Promise<void>

  • Parameters

    Returns void

writeJSON

  • writeJSON(file: string, object: any, options?: WriteOptions): Promise<void>
  • writeJSON(file: string, object: any, callback: function): void
  • writeJSON(file: string, object: any, options: WriteOptions, callback: function): void
  • Parameters

    Returns Promise<void>

  • Parameters

    • file: string
    • object: any
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Parameters

    • file: string
    • object: any
    • options: WriteOptions
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

writeJSONSync

  • writeJSONSync(file: string, object: any, options?: WriteOptions): void
  • Parameters

    Returns void

writeJson

  • writeJson(file: string, object: any, options?: WriteOptions): Promise<void>
  • writeJson(file: string, object: any, callback: function): void
  • writeJson(file: string, object: any, options: WriteOptions, callback: function): void
  • Parameters

    Returns Promise<void>

  • Parameters

    • file: string
    • object: any
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

  • Parameters

    • file: string
    • object: any
    • options: WriteOptions
    • callback: function
        • (err: Error): void
        • Parameters

          • err: Error

          Returns void

    Returns void

writeJsonSync

  • writeJsonSync(file: string, object: any, options?: WriteOptions): void
  • Parameters

    Returns void

Generated using TypeDoc