Flusspferd API and module docs

class io.File

Description

File access from JavaScript. Files are instances of io.Streams.

Superclass

io.Stream

Includes

io.Stream

Methods

Inherited from Stream

Constructor

new io.File([filename])
  • filename (String) – file to open

Create a new file object, and optionally open a file. File objects can currently be created without being associated with an open file, but this might change.

Class methods

  • create #

    io.File.create(name[, perms=0666]) ⇒ undefined
    • name (String) – filename
    • perms (int) – creation mode

    Create a file with the given permissions (which will be affected by the processes umask). When specifying permissions, don’t forget to prefix with the leading ‘0’ to as unix permissions are specified in octal.

  • exists #

    io.File.exists(path) ⇒ true | false
    • path (String) – filename

    Check if something exists at the given path - will not distingush between files and directories.

    Deprecated in favour of fs_base.exists.

Instance methods

  • close #

    io.File#close() ⇒ undefined

    Close the open file handle.

    Attempting to read a closed filed will do nothing, or throw. check behaviour

  • open #

    io.File#open(filename) ⇒ undefined
    • filename (String) – file to open

    Open a file.