c

io.scalajs.nodejs.fs

WriteStream

class WriteStream extends Writable

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

Linear Supertypes
Writable, IWritable, LegacyStream, IEventEmitter, Stream, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. WriteStream
  2. Writable
  3. IWritable
  4. LegacyStream
  5. IEventEmitter
  6. Stream
  7. Object
  8. Any
  9. AnyRef
  10. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new WriteStream(path: Path)

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 addListener(eventName: String, listener: Function): WriteStream.this.type

    Alias for emitter.on(eventName, listener).

    Alias for emitter.on(eventName, listener).

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.addListener(eventName, listener)

    See also

    on()

  5. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  6. def bytesWritten: Double

    The number of bytes written so far.

    The number of bytes written so far. Does not include data that is still queued for writing.

  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def close(callback: Function1[Unit, Any]): Unit

    Undocumented method

    Undocumented method

    See also

    https://github.com/nodejs/node-v0.x-archive/blob/cfcb1de130867197cbc9c6012b7e84e08e53d032/lib/fs.js#L1597-L1620

  9. def cork(): Unit

    Forces buffering of all writes.

    Forces buffering of all writes. Buffered data will be flushed either at stream.uncork() or at stream.end() call.

    Definition Classes
    IWritable
    Example:

    1. writable.cork()

  10. def destroy(): Unit
    Definition Classes
    IWritable
  11. def destroy(error: Error): Unit
    Definition Classes
    IWritable
  12. def destroyed: Boolean
    Definition Classes
    IWritable
  13. val domain: Domain
    Definition Classes
    IEventEmitter
  14. def emit(name: String, args: Any*): Boolean

    Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Synchronously calls each of the listeners registered for the event named eventName, in the order they were registered, passing the supplied arguments to each.

    Returns true if the event had listeners, false otherwise.

    name

    the event name

    args

    the event arguments

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.emit(name[, arg1][, arg2][, ...])

  15. def end(): WriteStream.this.type
    Definition Classes
    IWritable
  16. def end(callback: Function1[Error, Any]): WriteStream.this.type
    Definition Classes
    IWritable
  17. def end(chunk: String, encoding: String): WriteStream.this.type
    Definition Classes
    IWritable
  18. def end(chunk: String, encoding: String, callback: Function1[Error, Any]): WriteStream.this.type
    Definition Classes
    IWritable
  19. def end(chunk: Uint8Array): WriteStream.this.type
    Definition Classes
    IWritable
  20. def end(chunk: String): WriteStream.this.type
    Definition Classes
    IWritable
  21. def end(chunk: Uint8Array, callback: Function1[Error, Any]): WriteStream.this.type
    Definition Classes
    IWritable
  22. def end(chunk: String, callback: Function1[Error, Any]): WriteStream.this.type
    Definition Classes
    IWritable
  23. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  24. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  25. def eventNames(): Array[String]
    Definition Classes
    IEventEmitter
  26. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  27. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  28. def getMaxListeners(): Int

    Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

    Returns the current max listener value for the EventEmitter which is either set by emitter.setMaxListeners(n) or defaults to EventEmitter.defaultMaxListeners.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.getMaxListeners()

    See also

    setMaxListeners()

  29. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  30. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  32. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  33. def listenerCount(eventName: String): Int

    Returns the number of listeners listening to the event named eventName.

    Returns the number of listeners listening to the event named eventName.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.listenerCount(eventName)

  34. def listeners(eventName: String): Array[Function]

    Returns a copy of the array of listeners for the event named eventName.

    Returns a copy of the array of listeners for the event named eventName.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.listeners(eventName)

  35. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  37. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  38. def off(eventName: String, listner: Function): WriteStream.this.type
    Definition Classes
    IEventEmitter
  39. def on(eventName: String, listener: Function): WriteStream.this.type

    Adds the listener function to the end of the listeners array for the event named eventName.

    Adds the listener function to the end of the listeners array for the event named eventName. No checks are made to see if the listener has already been added. Multiple calls passing the same combination of eventName and listener will result in the listener being added, and called, multiple times.

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.on(eventName, listener)

  40. def once(eventName: String, listener: Function): WriteStream.this.type

    Adds a one time listener function for the event named eventName.

    Adds a one time listener function for the event named eventName. This listener is invoked only the next time eventName is triggered, after which it is removed.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.once(eventName, listener)

  41. def path: |[Buffer, String]

    The path to the file the stream is writing to as specified in the first argument to fs.createWriteStream().

    The path to the file the stream is writing to as specified in the first argument to fs.createWriteStream(). If path is passed as a string, then writeStream.path will be a string. If path is passed as a Buffer, then writeStream.path will be a Buffer.

  42. def prependListener(eventName: String, listener: Function): WriteStream.this.type
    Definition Classes
    IEventEmitter
  43. def prependOnceListener(eventName: String, listener: Function): WriteStream.this.type
    Definition Classes
    IEventEmitter
  44. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  45. def rawListeners(eventName: String): Array[Function]
    Definition Classes
    IEventEmitter
  46. def removeAllListeners(): WriteStream.this.type
    Definition Classes
    IEventEmitter
  47. def removeAllListeners(eventName: String): WriteStream.this.type

    Removes all listeners, or those of the specified eventName.

    Removes all listeners, or those of the specified eventName.

    Note that it is bad practice to remove listeners added elsewhere in the code, particularly when the EventEmitter instance was created by some other component or module (e.g. sockets or file streams).

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.removeAllListeners([eventName])

  48. def removeListener(eventName: String, listener: Function): WriteStream.this.type

    Removes the specified listener from the listener array for the event named eventName.

    Removes the specified listener from the listener array for the event named eventName. removeListener will remove, at most, one instance of a listener from the listener array. If any single listener has been added multiple times to the listener array for the specified eventName, then removeListener must be called multiple times to remove each instance.

    Note that once an event has been emitted, all listeners attached to it at the time of emitting will be called in order. This implies that any removeListener() or removeAllListeners() calls after emitting and before the last listener finishes execution will not remove them from emit() in progress. Subsequent events will behave as expected.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.removeListener(eventName, listener)

  49. def setDefaultEncoding(encoding: String): WriteStream.this.type

    Sets the default encoding for a writable stream.

    Sets the default encoding for a writable stream.

    Definition Classes
    IWritable
    Example:

    1. writable.setDefaultEncoding(encoding)

  50. def setMaxListeners(n: Int): WriteStream.this.type

    By default EventEmitters will print a warning if more than 10 listeners are added for a particular event.

    By default EventEmitters will print a warning if more than 10 listeners are added for a particular event. This is a useful default that helps finding memory leaks. Obviously, not all events should be limited to just 10 listeners. The emitter.setMaxListeners() method allows the limit to be modified for this specific EventEmitter instance. The value can be set to Infinity (or 0) for to indicate an unlimited number of listeners.

    Returns a reference to the EventEmitter so calls can be chained.

    Definition Classes
    IEventEmitter
    Example:

    1. emitter.setMaxListeners(n)

  51. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  52. def toLocaleString(): String
    Definition Classes
    Object
  53. def toString(): String
    Definition Classes
    AnyRef → Any
  54. def uncork(): Unit

    Flush all data, buffered since stream.cork() call.

    Flush all data, buffered since stream.cork() call.

    Definition Classes
    IWritable
    Example:

    1. writable.uncork()

  55. def valueOf(): Any
    Definition Classes
    Object
  56. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  57. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  58. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  59. def writable: Boolean
    Definition Classes
    IWritable
  60. def writableCorked: Int
    Definition Classes
    IWritable
  61. def writableEnded: Boolean
    Definition Classes
    IWritable
  62. def writableFinished: Boolean
    Definition Classes
    IWritable
  63. def writableHighWaterMark: Double
    Definition Classes
    IWritable
  64. def writableLength: Int
    Definition Classes
    IWritable
  65. def writableObjectMode: Boolean
    Definition Classes
    IWritable
  66. def write(chunk: String, encoding: String, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable
  67. def write(chunk: String, encoding: String): Boolean
    Definition Classes
    IWritable
  68. def write(chunk: String): Boolean
    Definition Classes
    IWritable
  69. def write(chunk: String, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable
  70. def write(chunk: Uint8Array): Boolean
    Definition Classes
    IWritable
  71. def write(chunk: Uint8Array, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable

Inherited from Writable

Inherited from IWritable

Inherited from LegacyStream

Inherited from IEventEmitter

Inherited from Stream

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped