Packages

trait FileHandle extends Object with StObject with _TransferListItem

Annotations
@JSType() @native()
Source
fsPromisesMod.scala
Linear Supertypes
_TransferListItem, StObject, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. FileHandle
  2. _TransferListItem
  3. StObject
  4. Object
  5. Any
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##: Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def appendFile(data: Uint8Array, options: BufferEncoding): Promise[Unit]
  5. def appendFile(data: Uint8Array, options: BaseEncodingOptionsmodeMoEncoding): Promise[Unit]
  6. def appendFile(data: Uint8Array): Promise[Unit]
  7. def appendFile(data: java.lang.String, options: BufferEncoding): Promise[Unit]
  8. def appendFile(data: java.lang.String, options: BaseEncodingOptionsmodeMoEncoding): Promise[Unit]
  9. def appendFile(data: java.lang.String): Promise[Unit]

    Asynchronously append data to a file, creating the file if it does not exist.

    Asynchronously append data to a file, creating the file if it does not exist. The underlying file will _not_ be closed automatically. The FileHandle must have been opened for appending.

    data

    The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string.

  10. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  11. def chmod(mode: Mode): Promise[Unit]

    Asynchronous fchmod(2) - Change permissions of a file.

    Asynchronous fchmod(2) - Change permissions of a file.

    mode

    A file mode. If a string is passed, it is parsed as an octal integer.

  12. def chown(uid: Double, gid: Double): Promise[Unit]

    Asynchronous fchown(2) - Change ownership of a file.

  13. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native() @IntrinsicCandidate()
  14. def close(): Promise[Unit]

    Asynchronous close(2) - close a FileHandle.

  15. def datasync(): Promise[Unit]

    Asynchronous fdatasync(2) - synchronize a file's in-core state with storage device.

  16. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  17. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  18. val fd: Double

    Gets the file descriptor for this file handle.

  19. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  20. def hasOwnProperty(v: scala.Predef.String): Boolean
    Definition Classes
    Object
  21. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @IntrinsicCandidate()
  22. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  23. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  24. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  26. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @IntrinsicCandidate()
  27. def propertyIsEnumerable(v: scala.Predef.String): Boolean
    Definition Classes
    Object
  28. def read[TBuffer](buffer: TBuffer, offset: Unit, length: Unit, position: Double): Promise[Buffer[TBuffer]]
  29. def read[TBuffer](buffer: TBuffer, offset: Unit, length: Null, position: Double): Promise[Buffer[TBuffer]]
  30. def read[TBuffer](buffer: TBuffer, offset: Unit, length: Double, position: Double): Promise[Buffer[TBuffer]]
  31. def read[TBuffer](buffer: TBuffer, offset: Unit, length: Double): Promise[Buffer[TBuffer]]
  32. def read[TBuffer](buffer: TBuffer, offset: Null, length: Unit, position: Double): Promise[Buffer[TBuffer]]
  33. def read[TBuffer](buffer: TBuffer, offset: Null, length: Null, position: Double): Promise[Buffer[TBuffer]]
  34. def read[TBuffer](buffer: TBuffer, offset: Null, length: Double, position: Double): Promise[Buffer[TBuffer]]
  35. def read[TBuffer](buffer: TBuffer, offset: Null, length: Double): Promise[Buffer[TBuffer]]
  36. def read[TBuffer](buffer: TBuffer, offset: Double, length: Unit, position: Double): Promise[Buffer[TBuffer]]
  37. def read[TBuffer](buffer: TBuffer, offset: Double, length: Null, position: Double): Promise[Buffer[TBuffer]]
  38. def read[TBuffer](buffer: TBuffer, offset: Double, length: Double, position: Double): Promise[Buffer[TBuffer]]
  39. def read[TBuffer](buffer: TBuffer, offset: Double, length: Double): Promise[Buffer[TBuffer]]
  40. def read[TBuffer](buffer: TBuffer, offset: Double): Promise[Buffer[TBuffer]]
  41. def read[TBuffer](buffer: TBuffer): Promise[Buffer[TBuffer]]

    Asynchronously reads data from the file.

    Asynchronously reads data from the file. The FileHandle must have been opened for reading.

    buffer

    The buffer that the data will be written to.

  42. def readFile(options: BufferEncoding): Promise[java.lang.String]
  43. def readFile(options: 3): Promise[Buffer]
  44. def readFile(options: EncodingBufferEncoding): Promise[java.lang.String]

    Asynchronously reads the entire contents of a file.

    Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. The FileHandle must have been opened for reading.

    options

    An object that may contain an optional flag. If a flag is not provided, it defaults to 'r'.

  45. def readFile(options: BaseEncodingOptionsflagOp): Promise[|[java.lang.String, Buffer]]
  46. def readFile(): Promise[Buffer]

    Asynchronously reads the entire contents of a file.

    Asynchronously reads the entire contents of a file. The underlying file will _not_ be closed automatically. The FileHandle must have been opened for reading.

  47. def readv(buffers: Array[ArrayBufferView], position: Double): Promise[ReadVResult]
  48. def readv(buffers: Array[ArrayBufferView]): Promise[ReadVResult]

    See fs.readv promisified version.

  49. def stat(opts: StatOptions): Promise[|[Stats, BigIntStats]]
  50. def stat(opts: StatOptionsbiginttrue): Promise[BigIntStats]
  51. def stat(opts: StatOptionsbigintfalseund): Promise[Stats]
  52. def stat(): Promise[Stats]

    Asynchronous fstat(2) - Get file status.

  53. def sync(): Promise[Unit]

    Asynchronous fsync(2) - synchronize a file's in-core state with the underlying storage device.

  54. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  55. def toLocaleString(): scala.Predef.String
    Definition Classes
    Object
  56. def toString(): java.lang.String
    Definition Classes
    AnyRef → Any
  57. def truncate(len: Double): Promise[Unit]
  58. def truncate(): Promise[Unit]

    Asynchronous ftruncate(2) - Truncate a file to a specified length.

  59. def utimes(atime: Double, mtime: Double): Promise[Unit]
  60. def utimes(atime: Double, mtime: Date): Promise[Unit]
  61. def utimes(atime: Double, mtime: java.lang.String): Promise[Unit]
  62. def utimes(atime: Date, mtime: Double): Promise[Unit]
  63. def utimes(atime: Date, mtime: Date): Promise[Unit]
  64. def utimes(atime: Date, mtime: java.lang.String): Promise[Unit]
  65. def utimes(atime: java.lang.String, mtime: Double): Promise[Unit]
  66. def utimes(atime: java.lang.String, mtime: Date): Promise[Unit]
  67. def utimes(atime: java.lang.String, mtime: java.lang.String): Promise[Unit]

    Asynchronously change file timestamps of the file.

    Asynchronously change file timestamps of the file.

    atime

    The last access time. If a string is provided, it will be coerced to number.

    mtime

    The last modified time. If a string is provided, it will be coerced to number.

  68. def valueOf(): Any
    Definition Classes
    Object
  69. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  70. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  71. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  72. def write[TBuffer](buffer: TBuffer, offset: Unit, length: Unit, position: Double): Promise[BytesWritten[TBuffer]]
  73. def write[TBuffer](buffer: TBuffer, offset: Unit, length: Null, position: Double): Promise[BytesWritten[TBuffer]]
  74. def write[TBuffer](buffer: TBuffer, offset: Unit, length: Double, position: Double): Promise[BytesWritten[TBuffer]]
  75. def write[TBuffer](buffer: TBuffer, offset: Unit, length: Double): Promise[BytesWritten[TBuffer]]
  76. def write[TBuffer](buffer: TBuffer, offset: Null, length: Unit, position: Double): Promise[BytesWritten[TBuffer]]
  77. def write[TBuffer](buffer: TBuffer, offset: Null, length: Null, position: Double): Promise[BytesWritten[TBuffer]]
  78. def write[TBuffer](buffer: TBuffer, offset: Null, length: Double, position: Double): Promise[BytesWritten[TBuffer]]
  79. def write[TBuffer](buffer: TBuffer, offset: Null, length: Double): Promise[BytesWritten[TBuffer]]
  80. def write[TBuffer](buffer: TBuffer, offset: Double, length: Unit, position: Double): Promise[BytesWritten[TBuffer]]
  81. def write[TBuffer](buffer: TBuffer, offset: Double, length: Null, position: Double): Promise[BytesWritten[TBuffer]]
  82. def write[TBuffer](buffer: TBuffer, offset: Double, length: Double, position: Double): Promise[BytesWritten[TBuffer]]
  83. def write[TBuffer](buffer: TBuffer, offset: Double, length: Double): Promise[BytesWritten[TBuffer]]
  84. def write[TBuffer](buffer: TBuffer, offset: Double): Promise[BytesWritten[TBuffer]]
  85. def write[TBuffer](buffer: TBuffer): Promise[BytesWritten[TBuffer]]

    Asynchronously writes buffer to the file.

    Asynchronously writes buffer to the file. The FileHandle must have been opened for writing.

    buffer

    The buffer that the data will be written to.

  86. def write(data: Uint8Array, position: Unit, encoding: BufferEncoding): Promise[BufferBytesWritten]
  87. def write(data: Uint8Array, position: Null, encoding: BufferEncoding): Promise[BufferBytesWritten]
  88. def write(data: Uint8Array, position: Double, encoding: BufferEncoding): Promise[BufferBytesWritten]
  89. def write(data: Uint8Array, position: Double): Promise[BufferBytesWritten]
  90. def write(data: Uint8Array): Promise[BufferBytesWritten]
  91. def write(data: java.lang.String, position: Unit, encoding: BufferEncoding): Promise[BufferBytesWritten]
  92. def write(data: java.lang.String, position: Null, encoding: BufferEncoding): Promise[BufferBytesWritten]
  93. def write(data: java.lang.String, position: Double, encoding: BufferEncoding): Promise[BufferBytesWritten]
  94. def write(data: java.lang.String, position: Double): Promise[BufferBytesWritten]
  95. def write(data: java.lang.String): Promise[BufferBytesWritten]

    Asynchronously writes string to the file.

    Asynchronously writes string to the file. The FileHandle must have been opened for writing. It is unsafe to call write() multiple times on the same file without waiting for the Promise to be resolved (or rejected). For this scenario, fs.createWriteStream is strongly recommended.

  96. def writeFile(data: Uint8Array, options: BufferEncoding): Promise[Unit]
  97. def writeFile(data: Uint8Array, options: BaseEncodingOptionsmodeMo): Promise[Unit]
  98. def writeFile(data: Uint8Array): Promise[Unit]
  99. def writeFile(data: java.lang.String, options: BufferEncoding): Promise[Unit]
  100. def writeFile(data: java.lang.String, options: BaseEncodingOptionsmodeMo): Promise[Unit]
  101. def writeFile(data: java.lang.String): Promise[Unit]

    Asynchronously writes data to a file, replacing the file if it already exists.

    Asynchronously writes data to a file, replacing the file if it already exists. The underlying file will _not_ be closed automatically. The FileHandle must have been opened for writing. It is unsafe to call writeFile() multiple times on the same file without waiting for the Promise to be resolved (or rejected).

    data

    The data to write. If something other than a Buffer or Uint8Array is provided, the value is coerced to a string.

  102. def writev(buffers: Array[ArrayBufferView], position: Double): Promise[WriteVResult]
  103. def writev(buffers: Array[ArrayBufferView]): Promise[WriteVResult]

    See fs.writev promisified version.

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable]) @Deprecated
    Deprecated

Inherited from _TransferListItem

Inherited from StObject

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped