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. type AsyncIterator[T] = Any
  2. trait BigIntStats extends Object with IStats[BigInt, BigInt]

    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
    @JSType() @native()
    Example:
    1. BigIntStats {
        dev: 2114n,
        ino: 48064969n,
        mode: 33188n,
        nlink: 1n,
        uid: 85n,
        gid: 100n,
        rdev: 0n,
        size: 527n,
        blksize: 4096n,
        blocks: 8n,
        atimeMs: 1318289051000n,
        mtimeMs: 1318289051000n,
        ctimeMs: 1318289051000n,
        birthtimeMs: 1318289051000n,
        atimeNs: 1318289051000000000n,
        mtimeNs: 1318289051000000000n,
        ctimeNs: 1318289051000000000n,
        birthtimeNs: 1318289051000000000n,
        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

  3. trait BufferIOResult[T] extends Object
    Annotations
    @JSType() @native()
  4. type BufferLike = |[TypedArray[_, _], DataView]
  5. trait CpOptions extends Object
    Annotations
    @JSType()
  6. type Dirent[T] = fs.Fs.Dirent[T]
  7. 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
    @JSType() @native()
  8. trait FSStatWatcher extends Object with IEventEmitter

    A successful call to fs.watchFile() method will return a new fs.StatWatcher object.

    A successful call to fs.watchFile() method will return a new fs.StatWatcher object.

    Annotations
    @JSType() @native()
  9. 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
    @JSType() @native()
  10. implicit final class FSWatcherExtensions[T <: FSWatcher] extends AnyVal

    File System Watcher Extensions

  11. trait FSWatcherOptions extends Object
    Annotations
    @JSType()
  12. trait FileAppendOptions extends Object
    Annotations
    @JSType()
  13. trait FileEncodingOptions extends Object
    Annotations
    @JSType()
  14. trait FileInputOptions extends Object
    Annotations
    @JSType()
  15. trait FileOutputOptions extends Object
    Annotations
    @JSType()
  16. trait FileWatchEvent extends Object
    Annotations
    @JSType()
  17. type FileWatchListener = |[Function2[Stats, Stats, Any], Function2[BigIntStats, BigIntStats, Any]]
  18. trait FileWatcherOptions extends Object
    Annotations
    @JSType()
  19. type FileWriteOptions = FileAppendOptions
  20. trait Fs extends Object

    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
    @JSType() @native()
  21. implicit final class FsDirExtensions[T] extends AnyVal

    Dir Extensions

  22. implicit final class FsExtensions extends AnyVal

    File System Extensions

  23. trait FsPromiseWatchOptions extends Object
    Annotations
    @JSType()
  24. trait IStats[TInt, TFloat] extends Object
    Annotations
    @JSType() @native()
  25. trait MkdirOptions extends Object
    Annotations
    @JSType()
  26. trait OpendirOptions extends Object
    Annotations
    @JSType()
  27. type Output = |[String, Buffer]
  28. type Path = |[|[Uint8Array, String], URL]
  29. trait ReadFileOptions extends Object
    Annotations
    @JSType()
  30. trait ReadOptions extends Object
    Annotations
    @JSType()
  31. class ReadStream extends Readable

    fs.ReadStream - ReadStream is a Readable Stream.

    fs.ReadStream - ReadStream is a Readable Stream.

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

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

  32. implicit final class ReadStreamExtensions[R <: ReadStream] extends AnyVal
  33. type ReaddirArrays = |[Array[String], Array[Buffer]]
  34. type ReaddirArrays2 = |[|[ReaddirArrays, Array[Dirent[String]]], Array[Dirent[Buffer]]]
  35. trait ReaddirOptions extends Object
    Annotations
    @JSType()
  36. trait RealpathObject extends Object
    Annotations
    @JSType() @native()
  37. trait RealpathSyncObject extends Object
    Annotations
    @JSType() @native()
  38. trait RmOptions extends Object
    Annotations
    @JSType()
  39. trait RmdirOptions extends Object
    Annotations
    @JSType()
  40. trait StatOptions extends Object
    Annotations
    @JSType()
  41. trait Stats extends Object with IStats[Int, Double]

    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
    @JSType() @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

  42. type StatsVariant = |[Stats, BigIntStats]
  43. type Time = |[|[Double, String], Date]
  44. type WatchListener = Function2[EventType, String, Any]
  45. class WriteStream extends Writable

    fs.WriteStream - WriteStream is a Writable Stream.

    fs.WriteStream - WriteStream is a Writable Stream.

    Annotations
    @JSType() @native() @JSImport("fs", "WriteStream")
    See also

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

  46. implicit final class WriteStreamExtensions[T <: WriteStream] extends AnyVal

    Write Stream Events

Value Members

  1. object CpOptions
  2. object FSWatcherOptions
  3. object FileAppendOptions
  4. object FileEncodingOptions
  5. object FileInputOptions
  6. object FileOutputOptions
  7. object FileWatcherOptions
  8. object Fs extends Object with Fs

    File System Singleton

    File System Singleton

    Annotations
    @native() @JSImport("fs", JSImport.Namespace)
  9. object FsPromiseWatchOptions
  10. object MkdirOptions
  11. object OpendirOptions
  12. object ReadFileOptions
  13. object ReadOptions
  14. object ReaddirOptions
  15. object RmOptions
  16. object RmdirOptions
  17. object StatOptions

Inherited from AnyRef

Inherited from Any

Ungrouped