Packages

package fs

fs package object

Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. fs
  2. AnyRef
  3. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Type Members

  1. trait BufferIOResult[T] extends Object
    Annotations
    @RawJSType() @native()
  2. type BufferLike = |[TypedArray[_, _], DataView]
  3. trait FSConstants extends Object

    An object containing commonly used constants for file system operations

    An object containing commonly used constants for file system operations

    Annotations
    @RawJSType() @native()
  4. trait FSWatcher extends Object with IEventEmitter

    fs.FSWatcher - Objects returned from fs.watch() are of this type.

    fs.FSWatcher - Objects returned from fs.watch() are of this type.

    Annotations
    @RawJSType() @native()
  5. class FSWatcherOptions extends Object

    FS Watcher Options

    FS Watcher Options

    Annotations
    @ScalaJSDefined() @RawJSType()
  6. class FileAppendOptions extends Object

    File Append Options

    File Append Options

    Annotations
    @ScalaJSDefined() @RawJSType()
  7. class FileEncodingOptions extends Object

    File Encoding Options

    File Encoding Options

    Annotations
    @ScalaJSDefined() @RawJSType()
  8. class FileInputOptions extends Object
    Annotations
    @ScalaJSDefined() @RawJSType()
  9. class FileOutputOptions extends Object
    Annotations
    @ScalaJSDefined() @RawJSType()
  10. class FileWatcherOptions extends Object

    File Watcher Options

    File Watcher Options

    Annotations
    @ScalaJSDefined() @RawJSType()
  11. type FileWriteOptions = FileAppendOptions
  12. trait Fs extends Object with IEventEmitter with FSConstants

    File I/O is provided by simple wrappers around standard POSIX functions.

    File I/O is provided by simple wrappers around standard POSIX functions. To use this module do require('fs'). All the methods have asynchronous and synchronous forms.

    The asynchronous form always takes a completion callback as its last argument. The arguments passed to the completion callback depend on the method, but the first argument is always reserved for an exception. If the operation was completed successfully, then the first argument will be null or undefined.

    When using the synchronous form any exceptions are immediately thrown. You can use try/catch to handle exceptions or allow them to bubble up.

    Annotations
    @RawJSType() @native()
  13. implicit final class FsExtensions extends AnyVal

    File System Extensions

  14. class MkdirOptions extends Object
    Annotations
    @ScalaJSDefined() @RawJSType()
  15. type Output = |[String, Buffer]
  16. type Path = |[|[Uint8Array, String], URL]
  17. class ReadFileOptions extends Object
    Annotations
    @ScalaJSDefined() @RawJSType()
  18. class ReadStream extends Readable

    fs.ReadStream - ReadStream is a Readable Stream.

    fs.ReadStream - ReadStream is a Readable Stream.

    Annotations
    @RawJSType() @native() @JSImport("fs", "ReadStream")
    See also

    https://nodejs.org/api/stream.html#stream_class_stream_readable

  19. type ReaddirArrays = |[Array[String], Array[Buffer]]
  20. class ReaddirOptions extends Object
    Annotations
    @ScalaJSDefined() @RawJSType()
  21. trait RealpathObject extends Object
    Annotations
    @RawJSType() @native()
  22. class RmdirOptions extends Object
    Annotations
    @ScalaJSDefined() @RawJSType()
  23. class StatOptions extends Object
    Annotations
    @ScalaJSDefined() @RawJSType()
  24. trait Stats extends Object

    fs.Stats (Stat Time Values) - Objects returned from fs.stat(), fs.lstat() and fs.fstat() and their synchronous counterparts are of this type.

    fs.Stats (Stat Time Values) - Objects returned from fs.stat(), fs.lstat() and fs.fstat() and their synchronous counterparts are of this type.

    Annotations
    @RawJSType() @native()
    Example:
    1.  Stats {
         dev: 2114,
         ino: 48064969,
         mode: 33188,
         nlink: 1,
         uid: 85,
         gid: 100,
         rdev: 0,
         size: 527,
         blksize: 4096,
         blocks: 8,
         atimeMs: 1318289051000.1,
         mtimeMs: 1318289051000.1,
         ctimeMs: 1318289051000.1,
         birthtimeMs: 1318289051000.1,
         atime: Mon, 10 Oct 2011 23:24:11 GMT,
         mtime: Mon, 10 Oct 2011 23:24:11 GMT,
         ctime: Mon, 10 Oct 2011 23:24:11 GMT,
         birthtime: Mon, 10 Oct 2011 23:24:11 GMT
      }
    Since

    0.1.21

  25. type Time = |[|[Int, String], Date]
  26. class WriteStream extends Writable

    fs.WriteStream - WriteStream is a Writable Stream.

    fs.WriteStream - WriteStream is a Writable Stream.

    Annotations
    @RawJSType() @native() @JSImport("fs", "ReadStream")
    See also

    https://nodejs.org/api/fs.html#fs_class_fs_writestream

Value Members

  1. object FSWatcher

    File System Watcher Companion

  2. object Fs extends Object with Fs

    File System Singleton

    File System Singleton

    Annotations
    @native() @JSImport("fs", JSImport.Namespace)
  3. object ReadStream

    Read Stream Companion

  4. object WriteStream

    Write Stream Companion

Inherited from AnyRef

Inherited from Any

Ungrouped