"fs" | typescript
Options
All
  • Public
  • Public/Protected
  • All
Menu

Module "fs"

Index

Modules

Interfaces

Functions

Functions

access

  • access(path: string | Buffer, callback: function): void
  • access(path: string | Buffer, mode: number, callback: function): void

  • Tests a user's permissions for the file specified by path.

    Parameters

    Returns void

  • Parameters

    Returns void

accessSync

  • accessSync(path: string | Buffer, mode?: number): void

  • Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise.

    Parameters

    • path: string | Buffer
    • Optional mode: number

    Returns void

appendFile

  • appendFile(filename: string, data: any, encoding: string, callback: function): void
  • appendFile(filename: string, data: any, options: object, callback?: function): void
  • appendFile(filename: string, data: any, options: object, callback?: function): void
  • appendFile(filename: string, data: any, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number
    • Optional callback: function

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string
    • Optional callback: function

    Returns void

  • Parameters

    Returns void

appendFileSync

  • appendFileSync(filename: string, data: any, encoding: string): void
  • appendFileSync(filename: string, data: any, options?: object): void
  • appendFileSync(filename: string, data: any, options?: object): void

  • Parameters

    • filename: string
    • data: any
    • encoding: string

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string

    Returns void

chmod

  • chmod(path: string | Buffer, mode: number, callback?: function): void
  • chmod(path: string | Buffer, mode: string, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

chmodSync

  • chmodSync(path: string | Buffer, mode: number): void
  • chmodSync(path: string | Buffer, mode: string): void

  • Parameters

    • path: string | Buffer
    • mode: number

    Returns void

  • Parameters

    • path: string | Buffer
    • mode: string

    Returns void

chown

  • chown(path: string | Buffer, uid: number, gid: number, callback?: function): void

  • Parameters

    Returns void

chownSync

  • chownSync(path: string | Buffer, uid: number, gid: number): void

  • Parameters

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

    Returns void

close

  • close(fd: number, callback?: function): void

  • Parameters

    Returns void

closeSync

  • closeSync(fd: number): void

  • Parameters

    • fd: number

    Returns void

createReadStream

  • Parameters

    • path: string | Buffer
    • Optional options: object
      • Optional autoClose?: boolean
      • Optional encoding?: string
      • Optional end?: number
      • Optional fd?: number
      • Optional flags?: string
      • Optional mode?: number
      • Optional start?: number

    Returns ReadStream

createWriteStream

  • Parameters

    • path: string | Buffer
    • Optional options: object
      • Optional autoClose?: boolean
      • Optional encoding?: string
      • Optional fd?: number
      • Optional flags?: string
      • Optional mode?: number
      • Optional start?: number

    Returns WriteStream

exists

  • exists(path: string | Buffer, callback?: function): void

  • Parameters

    • path: string | Buffer
    • Optional callback: function
        • (exists: boolean): void

        • Parameters

          • exists: boolean

          Returns void

    Returns void

existsSync

  • existsSync(path: string | Buffer): boolean

  • Parameters

    Returns boolean

fchmod

  • fchmod(fd: number, mode: number, callback?: function): void
  • fchmod(fd: number, mode: string, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

fchmodSync

  • fchmodSync(fd: number, mode: number): void
  • fchmodSync(fd: number, mode: string): void

  • Parameters

    • fd: number
    • mode: number

    Returns void

  • Parameters

    • fd: number
    • mode: string

    Returns void

fchown

  • fchown(fd: number, uid: number, gid: number, callback?: function): void

  • Parameters

    • fd: number
    • uid: number
    • gid: number
    • Optional callback: function

    Returns void

fchownSync

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

  • Parameters

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

    Returns void

fdatasync

  • fdatasync(fd: number, callback: Function): void

  • Parameters

    • fd: number
    • callback: Function

    Returns void

fdatasyncSync

  • fdatasyncSync(fd: number): void

  • Parameters

    • fd: number

    Returns void

fstat

  • fstat(fd: number, callback?: function): void

  • Parameters

    Returns void

fstatSync

  • fstatSync(fd: number): Stats

  • Parameters

    • fd: number

    Returns Stats

fsync

  • fsync(fd: number, callback?: function): void

  • Parameters

    Returns void

fsyncSync

  • fsyncSync(fd: number): void

  • Parameters

    • fd: number

    Returns void

ftruncate

  • ftruncate(fd: number, callback?: function): void
  • ftruncate(fd: number, len: number, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

ftruncateSync

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

  • Parameters

    • fd: number
    • Optional len: number

    Returns void

futimes

  • futimes(fd: number, atime: number, mtime: number, callback?: function): void
  • futimes(fd: number, atime: Date, mtime: Date, callback?: function): void

  • Parameters

    • fd: number
    • atime: number
    • mtime: number
    • Optional callback: function

    Returns void

  • Parameters

    • fd: number
    • atime: Date
    • mtime: Date
    • Optional callback: function

    Returns void

futimesSync

  • futimesSync(fd: number, atime: number, mtime: number): void
  • futimesSync(fd: number, atime: Date, mtime: Date): void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

lchmod

  • lchmod(path: string | Buffer, mode: number, callback?: function): void
  • lchmod(path: string | Buffer, mode: string, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

lchmodSync

  • lchmodSync(path: string | Buffer, mode: number): void
  • lchmodSync(path: string | Buffer, mode: string): void

  • Parameters

    • path: string | Buffer
    • mode: number

    Returns void

  • Parameters

    • path: string | Buffer
    • mode: string

    Returns void

lchown

  • lchown(path: string | Buffer, uid: number, gid: number, callback?: function): void

  • Parameters

    Returns void

lchownSync

  • lchownSync(path: string | Buffer, uid: number, gid: number): void

  • Parameters

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

    Returns void

link

  • link(srcpath: string | Buffer, dstpath: string | Buffer, callback?: function): void

  • Parameters

    Returns void

linkSync

  • linkSync(srcpath: string | Buffer, dstpath: string | Buffer): void

  • Parameters

    Returns void

lstat

  • lstat(path: string | Buffer, callback?: function): void

  • Parameters

    Returns void

lstatSync

  • Parameters

    Returns Stats

mkdir

  • mkdir(path: string | Buffer, callback?: function): void
  • mkdir(path: string | Buffer, mode: number, callback?: function): void
  • mkdir(path: string | Buffer, mode: string, callback?: function): void

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

    Parameters

    • path: string | Buffer
    • Optional 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
    • Optional 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: string
    • Optional callback: function

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

    Returns void

mkdirSync

  • mkdirSync(path: string | Buffer, mode?: number): void
  • mkdirSync(path: string | Buffer, mode?: string): void

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

    Parameters

    • path: string | Buffer
    • Optional mode: number

    Returns void

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

    Parameters

    • path: string | Buffer
    • Optional mode: string

    Returns void

mkdtemp

  • 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
    • Optional callback: function

      The created folder path is passed as a string to the callback's second parameter.

    Returns void

mkdtempSync

  • mkdtempSync(prefix: string): string

  • Synchronous 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 string

    Returns the created folder path.

open

  • open(path: string | Buffer, flags: string | number, callback: function): void
  • open(path: string | Buffer, flags: string | number, mode: number, callback: function): void

  • Parameters

    Returns void

  • Parameters

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

    Returns void

openSync

  • openSync(path: string | Buffer, flags: string | number, mode?: number): number

  • Parameters

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

    Returns number

read

  • read(fd: number, buffer: Buffer, offset: number, length: number, position: number | null, callback?: function): void

  • Parameters

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

    Returns void

readFile

  • readFile(filename: string, encoding: null, callback: function): void
  • readFile(filename: string, encoding: string, callback: function): void
  • readFile(filename: string, encoding: string | null, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, options: object, callback: function): void
  • readFile(filename: string, callback: function): void

  • Asynchronous readFile - Asynchronously reads the entire contents of a file.

    Parameters

    • filename: string
    • encoding: null
    • callback: function

      The callback is passed two arguments (err, data), where data is the contents of the file.

    Returns void

  • Parameters

    • filename: string
    • encoding: string
    • callback: function

    Returns void

  • Parameters

    Returns void

  • Asynchronous readFile - Asynchronously reads the entire contents of a file.

    Parameters

    • filename: string
    • options: object

      An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer.

      • encoding: null
      • Optional flag?: string
    • callback: function

      The callback is passed two arguments (err, data), where data is the contents of the file.

    Returns void

  • Parameters

    • filename: string
    • options: object
      • encoding: string
      • Optional flag?: string
    • callback: function

    Returns void

  • Parameters

    • filename: string
    • options: object
      • encoding: string | null
      • Optional flag?: string
    • callback: function

    Returns void

  • Asynchronous readFile - Asynchronously reads the entire contents of a file.

    Parameters

    • filename: string
    • options: object

      An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer.

      • Optional flag?: string
    • callback: function

      The callback is passed two arguments (err, data), where data is the contents of the file.

    Returns void

  • Asynchronous readFile - Asynchronously reads the entire contents of a file.

    Parameters

    • filename: string
    • callback: function

      The callback is passed two arguments (err, data), where data is the contents of the file.

    Returns void

readFileSync

  • readFileSync(filename: string, encoding: null): Buffer
  • readFileSync(filename: string, encoding: string): string
  • readFileSync(filename: string, encoding: string | null): string | Buffer
  • readFileSync(filename: string, options: object): Buffer
  • readFileSync(filename: string, options: object): string
  • readFileSync(filename: string, options: object): string | Buffer
  • readFileSync(filename: string, options?: object): Buffer

  • Synchronous readFile - Synchronously reads the entire contents of a file.

    Parameters

    • filename: string
    • encoding: null

    Returns Buffer

  • Parameters

    • filename: string
    • encoding: string

    Returns string

  • Parameters

    • filename: string
    • encoding: string | null

    Returns string | Buffer

  • Synchronous readFile - Synchronously reads the entire contents of a file.

    Parameters

    • filename: string
    • options: object

      An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer.

      • encoding: null
      • Optional flag?: string

    Returns Buffer

  • Parameters

    • filename: string
    • options: object
      • encoding: string
      • Optional flag?: string

    Returns string

  • Parameters

    • filename: string
    • options: object
      • encoding: string | null
      • Optional flag?: string

    Returns string | Buffer

  • Synchronous readFile - Synchronously reads the entire contents of a file.

    Parameters

    • filename: string
    • Optional options: object

      An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer.

      • Optional flag?: string

    Returns Buffer

readSync

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

  • Parameters

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

    Returns number

readdir

  • readdir(path: string | Buffer, callback?: function): void

  • Parameters

    Returns void

readdirSync

  • readdirSync(path: string | Buffer): string[]

  • Parameters

    Returns string[]

readlink

  • readlink(path: string | Buffer, callback?: function): void

  • Parameters

    Returns void

readlinkSync

  • readlinkSync(path: string | Buffer): string

  • Parameters

    Returns string

realpath

  • realpath(path: string | Buffer, callback?: function): void
  • realpath(path: string | Buffer, cache: object, callback: function): void

  • Parameters

    Returns void

  • Parameters

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

    Returns void

realpathSync

  • realpathSync(path: string | Buffer, cache?: object): string

  • Parameters

    • path: string | Buffer
    • Optional cache: object
      • [path: string]: string

    Returns string

rename

  • rename(oldPath: string, newPath: string, callback?: function): void

  • Asynchronous rename.

    Parameters

    • oldPath: string
    • newPath: string
    • Optional callback: function

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

    Returns void

renameSync

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

  • Synchronous rename

    Parameters

    • oldPath: string
    • newPath: string

    Returns void

rmdir

  • rmdir(path: string | Buffer, callback?: function): void

  • Asynchronous rmdir - removes the directory specified in {path}

    Parameters

    • path: string | Buffer
    • Optional callback: function

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

    Returns void

rmdirSync

  • rmdirSync(path: string | Buffer): void

  • Synchronous rmdir - removes the directory specified in {path}

    Parameters

    Returns void

stat

  • stat(path: string | Buffer, callback?: function): void

  • Parameters

    Returns void

statSync

  • Parameters

    Returns Stats

symlink

  • symlink(srcpath: string | Buffer, dstpath: string | Buffer, type?: string, callback?: function): void

  • Parameters

    Returns void

symlinkSync

  • symlinkSync(srcpath: string | Buffer, dstpath: string | Buffer, type?: string): void

  • Parameters

    • srcpath: string | Buffer
    • dstpath: string | Buffer
    • Optional type: string

    Returns void

truncate

  • truncate(path: string | Buffer, callback?: function): void
  • truncate(path: string | Buffer, len: number, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

truncateSync

  • truncateSync(path: string | Buffer, len?: number): void

  • Parameters

    • path: string | Buffer
    • Optional len: number

    Returns void

unlink

  • unlink(path: string | Buffer, callback?: function): void

  • Asynchronous unlink - deletes the file specified in {path}

    Parameters

    • path: string | Buffer
    • Optional callback: function

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

    Returns void

unlinkSync

  • unlinkSync(path: string | Buffer): void

  • Synchronous unlink - deletes the file specified in {path}

    Parameters

    Returns void

unwatchFile

  • unwatchFile(filename: string, listener?: function): void

  • Parameters

    • filename: string
    • Optional listener: function

    Returns void

utimes

  • utimes(path: string | Buffer, atime: number, mtime: number, callback?: function): void
  • utimes(path: string | Buffer, atime: Date, mtime: Date, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

utimesSync

  • utimesSync(path: string | Buffer, atime: number, mtime: number): void
  • utimesSync(path: string | Buffer, atime: Date, mtime: Date): void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

watch

  • watch(filename: string, listener?: function): FSWatcher
  • watch(filename: string, encoding: string, listener?: function): FSWatcher
  • watch(filename: string, options: object, listener?: function): FSWatcher

  • Parameters

    • filename: string
    • Optional listener: function
        • (event: string, filename: string): any

        • Parameters

          • event: string
          • filename: string

          Returns any

    Returns FSWatcher

  • Parameters

    • filename: string
    • encoding: string
    • Optional listener: function
        • (event: string, filename: string | Buffer): any

        • Parameters

          • event: string
          • filename: string | Buffer

          Returns any

    Returns FSWatcher

  • Parameters

    • filename: string
    • options: object
      • Optional encoding?: string
      • Optional persistent?: boolean
      • Optional recursive?: boolean
    • Optional listener: function
        • (event: string, filename: string | Buffer): any

        • Parameters

          • event: string
          • filename: string | Buffer

          Returns any

    Returns FSWatcher

watchFile

  • watchFile(filename: string, listener: function): void
  • watchFile(filename: string, options: object, listener: function): void

  • Parameters

    • filename: string
    • listener: function

    Returns void

  • Parameters

    • filename: string
    • options: object
      • Optional interval?: number
      • Optional persistent?: boolean
    • listener: function

    Returns 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

  • Parameters

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

    Returns void

  • Parameters

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

  • Parameters

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

    Returns void

writeFile

  • writeFile(filename: string, data: any, callback?: function): void
  • writeFile(filename: string, data: any, encoding: string, callback: function): void
  • writeFile(filename: string, data: any, options: object, callback?: function): void
  • writeFile(filename: string, data: any, options: object, callback?: function): void

  • Parameters

    Returns void

  • Parameters

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number
    • Optional callback: function

    Returns void

  • Parameters

    • filename: string
    • data: any
    • options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string
    • Optional callback: function

    Returns void

writeFileSync

  • writeFileSync(filename: string, data: any, encoding: string): void
  • writeFileSync(filename: string, data: any, options?: object): void
  • writeFileSync(filename: string, data: any, options?: object): void

  • Parameters

    • filename: string
    • data: any
    • encoding: string

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: number

    Returns void

  • Parameters

    • filename: string
    • data: any
    • Optional options: object
      • Optional encoding?: string
      • Optional flag?: string
      • Optional mode?: string

    Returns void

writeSync

  • writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number | null): number
  • writeSync(fd: number, data: any, position?: number | null, enconding?: string): number

  • Parameters

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

    Returns number

  • Parameters

    • fd: number
    • data: any
    • Optional position: number | null
    • Optional enconding: string

    Returns number

Legend

  • Module
  • Object literal
  • Variable
  • Function
  • Function with type parameter
  • Index signature
  • Type alias
  • Enumeration
  • Enumeration member
  • Property
  • Method
  • Interface
  • Interface with type parameter
  • Constructor
  • Property
  • Method
  • Index signature
  • Class
  • Class with type parameter
  • Constructor
  • Property
  • Method
  • Accessor
  • Index signature
  • Inherited constructor
  • Inherited property
  • Inherited method
  • Inherited accessor
  • Protected property
  • Protected method
  • Protected accessor
  • Private property
  • Private method
  • Private accessor
  • Static property
  • Static method

Generated using TypeDoc