Options
All
  • Public
  • Public/Protected
  • All
V1.7
  • V1.6
  • V1.7
Menu

Namespace fs

Bindings for libuv file system operations. See http://docs.libuv.org/en/v1.x/fs.html

Index

Functions

access

  • access(req: Fs, path: string, mode: number, callback: (error: Error, access: number) => void): Fs
  • access(req: Fs, path: string, mode: number): number
  • Non-blocking access

    Parameters

    • req: Fs
    • path: string
    • mode: number
    • callback: (error: Error, access: number) => void
        • (error: Error, access: number): void
        • Parameters

          • error: Error
          • access: number

          Returns void

    Returns Fs

  • Blocking access

    Parameters

    • req: Fs
    • path: string
    • mode: number

    Returns number

chmod

  • chmod(req: Fs, path: string, mode: number, callback: (error: Error) => void): Fs
  • chmod(req: Fs, path: string, mode: number): void
  • Non-blocking chmod

    Parameters

    • req: Fs
    • path: string
    • mode: number
    • callback: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking chmod

    Parameters

    • req: Fs
    • path: string
    • mode: number

    Returns void

chown

  • chown(req: Fs, path: string, uid: number, gid: number, callback: (error: Error) => void): Fs
  • chown(req: Fs, path: string, uid: number, gid: number): void
  • Non-blocking chown

    Parameters

    • req: Fs
    • path: string
    • uid: number
    • gid: number
    • callback: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking chown

    Parameters

    • req: Fs
    • path: string
    • uid: number
    • gid: number

    Returns void

close

  • close(req: Fs, fd: number, onClose: (error: Error) => void): Fs
  • close(req: Fs, fd: number): void
  • Non-blocking file close

    Parameters

    • req: Fs
    • fd: number
    • onClose: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking file close

    Parameters

    • req: Fs
    • fd: number

    Returns void

copyfile

  • copyfile(req: Fs, path: string, newPath: string, flags: number, onCopy: (error: Error) => void): Fs
  • copyfile(req: Fs, path: string, newPath: string, flags: number): void
  • Non-blocking copyfile

    Parameters

    • req: Fs
    • path: string
    • newPath: string
    • flags: number
    • onCopy: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking copyfile

    Parameters

    • req: Fs
    • path: string
    • newPath: string
    • flags: number

    Returns void

fchmod

  • fchmod(req: Fs, fd: number, mode: number, callback: (error: Error) => void): Fs
  • fchmod(req: Fs, fd: number, mode: number): void
  • Non-blocking fchmod

    Parameters

    • req: Fs
    • fd: number
    • mode: number
    • callback: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking fchmod

    Parameters

    • req: Fs
    • fd: number
    • mode: number

    Returns void

fchown

  • fchown(req: Fs, fd: number, uid: number, gid: number, callback: (error: Error) => void): Fs
  • fchown(req: Fs, fd: number, uid: number, gid: number): void
  • Non-blocking fchown

    Parameters

    • req: Fs
    • fd: number
    • uid: number
    • gid: number
    • callback: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking fchown

    Parameters

    • req: Fs
    • fd: number
    • uid: number
    • gid: number

    Returns void

fdatasync

  • fdatasync(req: Fs, fd: number, onSync: (error: Error) => void): Fs
  • fdatasync(req: Fs, fd: number): void
  • Non-blocking fdatasync

    Parameters

    • req: Fs
    • fd: number
    • onSync: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking fdatasync

    Parameters

    • req: Fs
    • fd: number

    Returns void

fstat

fsync

  • fsync(req: Fs, fd: number, onSync: (error: Error) => void): Fs
  • fsync(req: Fs, fd: number): void
  • Non-blocking fsync

    Parameters

    • req: Fs
    • fd: number
    • onSync: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking fsync

    Parameters

    • req: Fs
    • fd: number

    Returns void

ftruncate

  • ftruncate(req: Fs, fd: number, onTruncate: (error: Error) => void): Fs
  • ftruncate(req: Fs, fd: number): void
  • Non-blocking truncate

    Parameters

    • req: Fs
    • fd: number
    • onTruncate: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking truncate

    Parameters

    • req: Fs
    • fd: number

    Returns void

futime

  • futime(req: Fs, fd: number, atime: number, mtime: number, callback: (error: Error) => void): Fs
  • futime(req: Fs, fd: number, atime: number, mtime: number): void
  • Non-blocking futime

    Parameters

    • req: Fs
    • fd: number
    • atime: number
    • mtime: number
    • callback: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking futime

    Parameters

    • req: Fs
    • fd: number
    • atime: number
    • mtime: number

    Returns void

lchown

  • lchown(req: Fs, path: string, uid: number, gid: number, callback: (error: Error) => void): Fs
  • lchown(req: Fs, path: string, uid: number, gid: number): void
  • Non-blocking lchown

    Parameters

    • req: Fs
    • path: string
    • uid: number
    • gid: number
    • callback: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking lchown

    Parameters

    • req: Fs
    • path: string
    • uid: number
    • gid: number

    Returns void

link

  • link(req: Fs, path: string, newPath: string, callback: (error: Error) => void): Fs
  • link(req: Fs, path: string, newPath: string): void
  • Non-blocking link

    Parameters

    • req: Fs
    • path: string
    • newPath: string
    • callback: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking link

    Parameters

    • req: Fs
    • path: string
    • newPath: string

    Returns void

lstat

  • lstat(req: Fs, path: string, onStat: (error: Error, stat: StatEntry) => void): Fs
  • lstat(req: Fs, path: string): StatEntry

mkdir

  • mkdir(req: Fs, path: string, mode: number, onMkdir: (error: Error) => void): Fs
  • mkdir(req: Fs, path: string, mode: number): void
  • Non-blocking mkdir

    Parameters

    • req: Fs
    • path: string
    • mode: number
    • onMkdir: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking mkdir

    Parameters

    • req: Fs
    • path: string
    • mode: number

    Returns void

mkdtemp

  • mkdtemp(req: Fs, template: string, onMkdtemp: (error: Error, path: string) => void): Fs
  • mkdtemp(req: Fs, template: string): string
  • Non-blocking mkdtemp

    Parameters

    • req: Fs
    • template: string
    • onMkdtemp: (error: Error, path: string) => void
        • (error: Error, path: string): void
        • Parameters

          • error: Error
          • path: string

          Returns void

    Returns Fs

  • Blocking mkdtemp

    Parameters

    • req: Fs
    • template: string

    Returns string

open

  • open(req: Fs, path: string, flags: Flags, mode: number, onOpen: (error: Error, fd: number) => void): Fs
  • open(req: Fs, path: string, flags: Flags, mode: number): number
  • Non-blocking file open

    Parameters

    • req: Fs
    • path: string
    • flags: Flags
    • mode: number
    • onOpen: (error: Error, fd: number) => void
        • (error: Error, fd: number): void
        • Parameters

          • error: Error
          • fd: number

          Returns void

    Returns Fs

  • Blocking file open

    Parameters

    • req: Fs
    • path: string
    • flags: Flags
    • mode: number

    Returns number

read

  • read(req: Fs, fd: number, buffer: ArrayBufferView | ArrayBuffer, position: number, onRead: (error: Error, bytesRead: number) => void): Fs
  • read(req: Fs, fd: number, buffer: ArrayBufferView | ArrayBuffer, position: number): number
  • Non-blocking file read

    Parameters

    • req: Fs
    • fd: number
    • buffer: ArrayBufferView | ArrayBuffer
    • position: number
    • onRead: (error: Error, bytesRead: number) => void
        • (error: Error, bytesRead: number): void
        • Parameters

          • error: Error
          • bytesRead: number

          Returns void

    Returns Fs

  • Blocking file read

    Parameters

    • req: Fs
    • fd: number
    • buffer: ArrayBufferView | ArrayBuffer
    • position: number

    Returns number

readlink

  • readlink(req: Fs, path: string, callback: (error: Error, path: string) => void): Fs
  • readlink(req: Fs, path: string): string
  • Non-blocking readlink

    Parameters

    • req: Fs
    • path: string
    • callback: (error: Error, path: string) => void
        • (error: Error, path: string): void
        • Parameters

          • error: Error
          • path: string

          Returns void

    Returns Fs

  • Blocking readlink

    Parameters

    • req: Fs
    • path: string

    Returns string

realpath

  • realpath(req: Fs, path: string, callback: (error: Error, path: string) => void): Fs
  • realpath(req: Fs, path: string): string
  • Non-blocking realpath

    Parameters

    • req: Fs
    • path: string
    • callback: (error: Error, path: string) => void
        • (error: Error, path: string): void
        • Parameters

          • error: Error
          • path: string

          Returns void

    Returns Fs

  • Blocking realpath

    Parameters

    • req: Fs
    • path: string

    Returns string

rename

  • rename(req: Fs, path: string, newPath: string, onRename: (error: Error) => void): Fs
  • rename(req: Fs, path: string, newPath: string): void
  • Non-blocking file path rename

    Parameters

    • req: Fs
    • path: string
    • newPath: string
    • onRename: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking file path rename

    Parameters

    • req: Fs
    • path: string
    • newPath: string

    Returns void

rmdir

  • rmdir(req: Fs, path: string, onRmdir: (error: Error) => void): Fs
  • rmdir(req: Fs, path: string): void
  • Non-blocking rmdir

    Parameters

    • req: Fs
    • path: string
    • onRmdir: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking rmdir

    Parameters

    • req: Fs
    • path: string

    Returns void

scandir

  • scandir(req: Fs, path: string, flags: number, onScandir: (error: Error, req: Fs) => void): Fs
  • scandir(req: Fs, path: string, flags: number): Fs
  • Non-blocking scandir

    Parameters

    • req: Fs
    • path: string
    • flags: number
    • onScandir: (error: Error, req: Fs) => void
        • (error: Error, req: Fs): void
        • Parameters

          • error: Error
          • req: Fs

          Returns void

    Returns Fs

  • Blocking scandir

    Parameters

    • req: Fs
    • path: string
    • flags: number

    Returns Fs

scandirNext

  • scandirNext(req: Fs): { name: string; type: string } | undefined
  • Get next entry in scandir result

    Parameters

    Returns { name: string; type: string } | undefined

sendfile

  • sendfile(req: Fs, outFd: number, inFd: number, offset: number, length: number, onSend: (error: Error, bytesSent: number) => void): Fs
  • sendfile(req: Fs, outFd: number, inFd: number, offset: number, length: number): number
  • Non-blocking sendfile

    Parameters

    • req: Fs
    • outFd: number
    • inFd: number
    • offset: number
    • length: number
    • onSend: (error: Error, bytesSent: number) => void
        • (error: Error, bytesSent: number): void
        • Parameters

          • error: Error
          • bytesSent: number

          Returns void

    Returns Fs

  • Blocking sendfile

    Parameters

    • req: Fs
    • outFd: number
    • inFd: number
    • offset: number
    • length: number

    Returns number

stat

  • stat(req: Fs, path: string, onStat: (error: Error, stat: StatEntry) => void): Fs
  • stat(req: Fs, path: string): StatEntry

symlink

  • symlink(req: Fs, path: string, newPath: string, flags: number, callback: (error: Error) => void): Fs
  • symlink(req: Fs, path: string, newPath: string, flags: number): void
  • Non-blocking symlink

    Parameters

    • req: Fs
    • path: string
    • newPath: string
    • flags: number
    • callback: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking symlink

    Parameters

    • req: Fs
    • path: string
    • newPath: string
    • flags: number

    Returns void

unlink

  • unlink(req: Fs, path: string, onUnlink: (error: Error) => void): Fs
  • unlink(req: Fs, path: string): void
  • Non-blocking file unlink

    Parameters

    • req: Fs
    • path: string
    • onUnlink: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking file unlink

    Parameters

    • req: Fs
    • path: string

    Returns void

utime

  • utime(req: Fs, path: string, atime: number, mtime: number, callback: (error: Error) => void): Fs
  • utime(req: Fs, path: string, atime: number, mtime: number): void
  • Non-blocking utime

    Parameters

    • req: Fs
    • path: string
    • atime: number
    • mtime: number
    • callback: (error: Error) => void
        • (error: Error): void
        • Parameters

          • error: Error

          Returns void

    Returns Fs

  • Blocking utime

    Parameters

    • req: Fs
    • path: string
    • atime: number
    • mtime: number

    Returns void

write

  • write(req: Fs, fd: number, buffer: ArrayBufferView | ArrayBuffer, position: number, onWrite: (error: Error, bytesWritten: number) => void): Fs
  • write(req: Fs, fd: number, buffer: ArrayBufferView | ArrayBuffer, position: number): number
  • Non-blocking file write

    Parameters

    • req: Fs
    • fd: number
    • buffer: ArrayBufferView | ArrayBuffer
    • position: number
    • onWrite: (error: Error, bytesWritten: number) => void
        • (error: Error, bytesWritten: number): void
        • Parameters

          • error: Error
          • bytesWritten: number

          Returns void

    Returns Fs

  • Blocking file write

    Parameters

    • req: Fs
    • fd: number
    • buffer: ArrayBufferView | ArrayBuffer
    • position: number

    Returns number

Generated using TypeDoc