Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • FS

Index

Methods

allocate

  • allocate(stream: FSStream, offset: number, length: number): void

analyzePath

  • analyzePath(p: string): any

chdir

  • chdir(path: string): void

chmod

  • chmod(path: string, mode: number, dontFollow?: undefined | false | true): void
  • Parameters

    • path: string
    • mode: number
    • Optional dontFollow: undefined | false | true

    Returns void

chown

  • chown(path: string, uid: number, gid: number, dontFollow?: undefined | false | true): void
  • Parameters

    • path: string
    • uid: number
    • gid: number
    • Optional dontFollow: undefined | false | true

    Returns void

close

createDataFile

  • createDataFile(parent: string, name: string, data: ArrayBufferView, canRead: boolean, canWrite: boolean, canOwn: boolean): void
  • Parameters

    • parent: string
    • name: string
    • data: ArrayBufferView
    • canRead: boolean
    • canWrite: boolean
    • canOwn: boolean

    Returns void

createLazyFile

  • createLazyFile(parent: string, name: string, url: string, canRead: boolean, canWrite: boolean): FSNode
  • createLazyFile(parent: FSNode, name: string, url: string, canRead: boolean, canWrite: boolean): FSNode

createPreloadedFile

  • createPreloadedFile(parent: string, name: string, url: string, canRead: boolean, canWrite: boolean, onload?: undefined | function, onerror?: undefined | function, dontCreateFile?: undefined | false | true, canOwn?: undefined | false | true): void
  • createPreloadedFile(parent: FSNode, name: string, url: string, canRead: boolean, canWrite: boolean, onload?: undefined | function, onerror?: undefined | function, dontCreateFile?: undefined | false | true, canOwn?: undefined | false | true): void
  • Parameters

    • parent: string
    • name: string
    • url: string
    • canRead: boolean
    • canWrite: boolean
    • Optional onload: undefined | function
    • Optional onerror: undefined | function
    • Optional dontCreateFile: undefined | false | true
    • Optional canOwn: undefined | false | true

    Returns void

  • Parameters

    • parent: FSNode
    • name: string
    • url: string
    • canRead: boolean
    • canWrite: boolean
    • Optional onload: undefined | function
    • Optional onerror: undefined | function
    • Optional dontCreateFile: undefined | false | true
    • Optional canOwn: undefined | false | true

    Returns void

cwd

  • cwd(): string

fchmod

  • fchmod(fd: number, mode: number): void

fchown

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

ftruncate

  • ftruncate(fd: number, len: number): void

getPath

  • getPath(node: FSNode): string

init

  • init(input: function, output: function, error: function): void
  • Parameters

    • input: function
        • (): number
        • Returns number

    • output: function
        • (c: number): any
        • Parameters

          • c: number

          Returns any

    • error: function
        • (c: number): any
        • Parameters

          • c: number

          Returns any

    Returns void

ioctl

  • ioctl(stream: FSStream, cmd: any, arg: any): any

isBlkdev

  • isBlkdev(mode: number): boolean

isChrdev

  • isChrdev(mode: number): boolean

isDir

  • isDir(mode: number): boolean

isFIFO

  • isFIFO(mode: number): boolean

isFile

  • isFile(mode: number): boolean

isLink

  • isLink(mode: number): boolean

isSocket

  • isSocket(mode: number): boolean

lchmod

  • lchmod(path: string, mode: number): void

lchown

  • lchown(path: string, uid: number, gid: number): void

llseek

  • llseek(stream: FSStream, offset: number, whence: number): any

lookupPath

  • lookupPath(path: string, opts: any): Lookup

lstat

  • lstat(path: string): any

major

  • major(dev: number): number

makedev

  • makedev(ma: number, mi: number): number

minor

  • minor(dev: number): number

mkdev

  • mkdev(path: string, mode?: undefined | number, dev?: undefined | number): any
  • Parameters

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

    Returns any

mkdir

  • mkdir(path: string, mode?: undefined | number): any

mmap

  • mmap(stream: FSStream, buffer: ArrayBufferView, offset: number, length: number, position: number, prot: number, flags: number): any
  • Parameters

    • stream: FSStream
    • buffer: ArrayBufferView
    • offset: number
    • length: number
    • position: number
    • prot: number
    • flags: number

    Returns any

mount

  • mount(type: any, opts: any, mountpoint: string): any

open

  • open(path: string, flags: string, mode?: undefined | number, fd_start?: undefined | number, fd_end?: undefined | number): FSStream
  • Parameters

    • path: string
    • flags: string
    • Optional mode: undefined | number
    • Optional fd_start: undefined | number
    • Optional fd_end: undefined | number

    Returns FSStream

read

  • read(stream: FSStream, buffer: ArrayBufferView, offset: number, length: number, position?: undefined | number): number
  • Parameters

    • stream: FSStream
    • buffer: ArrayBufferView
    • offset: number
    • length: number
    • Optional position: undefined | number

    Returns number

readFile

  • readFile(path: string, opts?: undefined | object): ArrayBufferView
  • Parameters

    • path: string
    • Optional opts: undefined | object

    Returns ArrayBufferView

readdir

  • readdir(path: string): string[]

readlink

  • readlink(path: string): string

registerDevice

  • registerDevice(dev: number, ops: any): void

rename

  • rename(old_path: string, new_path: string): void

rmdir

  • rmdir(path: string): void

stat

  • stat(path: string, dontFollow?: undefined | false | true): any
  • Parameters

    • path: string
    • Optional dontFollow: undefined | false | true

    Returns any

symlink

  • symlink(oldpath: string, newpath: string): any

syncfs

  • syncfs(populate: boolean, callback: function): void
  • syncfs(callback: function, populate?: undefined | false | true): void
  • Parameters

    • populate: boolean
    • callback: function
        • (e: any): any
        • Parameters

          • e: any

          Returns any

    Returns void

  • Parameters

    • callback: function
        • (e: any): any
        • Parameters

          • e: any

          Returns any

    • Optional populate: undefined | false | true

    Returns void

truncate

  • truncate(path: string, len: number): void

unlink

  • unlink(path: string): void

unmount

  • unmount(mountpoint: string): void

utime

  • utime(path: string, atime: number, mtime: number): void

write

  • write(stream: FSStream, buffer: ArrayBufferView, offset: number, length: number, position?: undefined | number, canOwn?: undefined | false | true): number
  • Parameters

    • stream: FSStream
    • buffer: ArrayBufferView
    • offset: number
    • length: number
    • Optional position: undefined | number
    • Optional canOwn: undefined | false | true

    Returns number

writeFile

  • writeFile(path: string, data: ArrayBufferView, opts?: undefined | object): void
  • writeFile(path: string, data: string, opts?: undefined | object): void
  • Parameters

    • path: string
    • data: ArrayBufferView
    • Optional opts: undefined | object

    Returns void

  • Parameters

    • path: string
    • data: string
    • Optional opts: undefined | object

    Returns void

Generated using TypeDoc