Trait

io.scalajs.nodejs.zlib

Inflate

Related Doc: package zlib

Permalink

trait Inflate extends Object with CompressionAlgorithm with Readable

Decompress a deflate stream.

Annotations
@RawJSType() @native()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Inflate
  2. CompressionAlgorithm
  3. Writable
  4. Readable
  5. IEventEmitter
  6. Object
  7. Any
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  4. def _read(size: Int): Unit

    Permalink

    All Readable stream implementations must provide an implementation of the readable._read() method to fetch data from the underlying resource.

    All Readable stream implementations must provide an implementation of the readable._read() method to fetch data from the underlying resource.

    When readable._read() is called, if data is available from the resource, the implementation should begin pushing that data into the read queue using the this.push(dataChunk) method. _read() should continue reading from the resource and pushing data until readable.push() returns false. Only when _read() is called again after it has stopped should it resume pushing additional data onto the queue.

    size

    the number of bytes to read asynchronously

    Definition Classes
    Readable
  5. def _readableState: ReadableState

    Permalink
    Definition Classes
    Readable
  6. def _write(chunk: Buffer, callback: Function1[Error, Any]): Unit

    Permalink

    All Writable stream implementations must provide a writable._write() method to send data to the underlying resource.

    All Writable stream implementations must provide a writable._write() method to send data to the underlying resource.

    chunk

    The chunk to be written. Will always be a buffer unless the decodeStrings option was set to false.

    callback

    Call this function (optionally with an error argument) when processing is complete for the supplied chunk.

    Definition Classes
    Writable
  7. def _write(chunk: String, encoding: String, callback: Function1[Error, Any]): Unit

    Permalink

    All Writable stream implementations must provide a writable._write() method to send data to the underlying resource.

    All Writable stream implementations must provide a writable._write() method to send data to the underlying resource.

    chunk

    The chunk to be written. Will always be a buffer unless the decodeStrings option was set to false.

    encoding

    If the chunk is a string, then encoding is the character encoding of that string. If chunk is a Buffer, or if the stream is operating in object mode, encoding may be ignored.

    callback

    Call this function (optionally with an error argument) when processing is complete for the supplied chunk.

    Definition Classes
    Writable
  8. def _writev(chunks: Array[Chunk], callback: Function1[Error, Any]): Unit

    Permalink

    The writable._writev() method may be implemented in addition to writable._write() in stream implementations that are capable of processing multiple chunks of data at once.

    The writable._writev() method may be implemented in addition to writable._write() in stream implementations that are capable of processing multiple chunks of data at once. If implemented, the method will be called with all chunks of data currently buffered in the write queue.

    chunks

    The chunks to be written. Each chunk has following format: { chunk: ..., encoding: ... }.

    callback

    A callback function (optionally with an error argument) to be invoked when processing is complete for the supplied chunks.

    Definition Classes
    Writable
  9. def addListener(eventName: String, listener: Function): Inflate.this.type

    Permalink

    Alias for emitter.on(eventName, listener).

    Alias for emitter.on(eventName, listener).

    Definition Classes
    IEventEmitter
    Example:
    1. emitter.addListener(eventName, listener)

    See also

    on()

  10. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  11. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  12. def cork(): Unit

    Permalink

    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
    Writable
    Example:
    1. writable.cork()

  13. var domain: String

    Permalink
    Definition Classes
    IEventEmitter
  14. def emit(name: String, args: Any*): Any

    Permalink

    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(): Unit

    Permalink

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    Definition Classes
    Writable
    Example:
    1. writable.end([chunk][, encoding][, callback])

  16. def end(callback: Function1[Error, Any]): Unit

    Permalink

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    callback

    the Callback for when this chunk of data is flushed

    Definition Classes
    Writable
    Example:
    1. writable.end([chunk][, encoding][, callback])

  17. def end(chunk: String, callback: Function1[Error, Any]): Unit

    Permalink

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    chunk

    The data to write (<String> | <Buffer>)

    Definition Classes
    Writable
    Example:
    1. writable.end([chunk][, encoding][, callback])

  18. def end(chunk: String, encoding: String): Unit

    Permalink

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    chunk

    The data to write (<String> | <Buffer>)

    encoding

    The encoding, if chunk is a String

    Definition Classes
    Writable
    Example:
    1. writable.end([chunk][, encoding][, callback])

  19. def end(chunk: String, encoding: String, callback: Function1[Error, Any]): Unit

    Permalink

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    chunk

    The data to write (<String> | <Buffer>)

    encoding

    The encoding, if chunk is a String

    Definition Classes
    Writable
    Example:
    1. writable.end([chunk][, encoding][, callback])

  20. def end(chunk: Buffer): Unit

    Permalink

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    chunk

    The data to write (<String> | <Buffer>)

    Definition Classes
    Writable
    Example:
    1. writable.end([chunk][, encoding][, callback])

  21. def end(chunk: Buffer, callback: Function1[Error, Any]): Unit

    Permalink

    Call this method when no more data will be written to the stream.

    Call this method when no more data will be written to the stream. If supplied, the callback is attached as a listener on the 'finish' event. Calling stream.write() after calling stream.end() will raise an error.

    chunk

    The data to write (<String> | <Buffer>)

    callback

    the Callback for when this chunk of data is flushed

    Definition Classes
    Writable
    Example:
    1. writable.end([chunk][, encoding][, callback])

  22. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  23. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  24. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  25. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  26. def getMaxListeners(): Int

    Permalink

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

  27. def hasOwnProperty(v: String): Boolean

    Permalink
    Definition Classes
    Object
  28. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  29. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  30. def isPaused(): Boolean

    Permalink

    This method returns whether or not the readable has been explicitly paused by client code (using stream.pause() without a corresponding stream.resume()).

    This method returns whether or not the readable has been explicitly paused by client code (using stream.pause() without a corresponding stream.resume()).

    Definition Classes
    Readable
    Example:
    1. readable.isPaused()

  31. def isPrototypeOf(v: Object): Boolean

    Permalink
    Definition Classes
    Object
  32. def listenerCount(eventName: String): Int

    Permalink

    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)

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

    Permalink

    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)

  34. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  35. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  36. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  37. def on(eventName: String, listener: Function): Inflate.this.type

    Permalink

    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)

  38. def once(eventName: String, listener: Function): Inflate.this.type

    Permalink

    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)

  39. def pause(): Inflate.this.type

    Permalink

    This method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode.

    This method will cause a stream in flowing mode to stop emitting 'data' events, switching out of flowing mode. Any data that becomes available will remain in the internal buffer.

    Definition Classes
    Readable
    Example:
    1. readable.pause()

  40. def pipe(destination: Writable, options: |[ReadablePipeOptions, RawOptions] = js.native): Inflate.this.type

    Permalink

    This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream.

    This method pulls all the data out of a readable stream, and writes it to the supplied destination, automatically managing the flow so that the destination is not overwhelmed by a fast readable stream. Multiple destinations can be piped to safely.

    Definition Classes
    Readable
    Example:
    1. readable.pipe(destination[, options])

  41. def propertyIsEnumerable(v: String): Boolean

    Permalink
    Definition Classes
    Object
  42. def push(chunk: Buffer): Boolean

    Permalink

    When chunk is a Buffer or string, the chunk of data will be added to the internal queue for users of the stream to consume.

    When chunk is a Buffer or string, the chunk of data will be added to the internal queue for users of the stream to consume. Passing chunk as null signals the end of the stream (EOF), after which no more data can be written.

    When the Readable is operating in paused mode, the data added with readable.push() can be read out by calling the readable.read() method when the 'readable' event is emitted.

    When the Readable is operating in flowing mode, the data added with readable.push() will be delivered by emitting a 'data' event.

    chunk

    the chunk of data to push into the read queue

    returns

    true if additional chunks of data may continued to be pushed; false otherwise.

    Definition Classes
    Readable
  43. def push(chunk: String, encoding: String = js.native): Boolean

    Permalink

    When chunk is a Buffer or string, the chunk of data will be added to the internal queue for users of the stream to consume.

    When chunk is a Buffer or string, the chunk of data will be added to the internal queue for users of the stream to consume. Passing chunk as null signals the end of the stream (EOF), after which no more data can be written.

    When the Readable is operating in paused mode, the data added with readable.push() can be read out by calling the readable.read() method when the 'readable' event is emitted.

    When the Readable is operating in flowing mode, the data added with readable.push() will be delivered by emitting a 'data' event.

    chunk

    the chunk of data to push into the read queue

    encoding

    the encoding of String chunks. Must be a valid Buffer encoding, such as 'utf8' or 'ascii'

    returns

    true if additional chunks of data may continued to be pushed; false otherwise.

    Definition Classes
    Readable
  44. def read[T](size: Int = js.native): T

    Permalink

    The read() method pulls some data out of the internal buffer and returns it.

    The read() method pulls some data out of the internal buffer and returns it. If there is no data available, then it will return null.

    If you pass in a size argument, then it will return that many bytes. If size bytes are not available, then it will return null, unless we've ended, in which case it will return the data remaining in the buffer.

    If you do not specify a size argument, then it will return all the data in the internal buffer.

    This method should only be called in paused mode. In flowing mode, this method is called automatically until the internal buffer is drained.

    Definition Classes
    Readable
    Example:
    1. readable.read([size])

  45. def removeAllListeners(): Inflate.this.type

    Permalink

    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])

  46. def removeAllListeners(eventName: String): Inflate.this.type

    Permalink

    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])

  47. def removeListener(eventName: String, listener: Function): Inflate.this.type

    Permalink

    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)

  48. def resume(): Inflate.this.type

    Permalink

    This method will cause the readable stream to resume emitting 'data' events.

    This method will cause the readable stream to resume emitting 'data' events. This method will switch the stream into flowing mode. If you do not want to consume the data from a stream, but you do want to get to its 'end' event, you can call stream.resume() to open the flow of data.

    Definition Classes
    Readable
    Example:
    1. readable.resume()

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

    Permalink

    Sets the default encoding for a writable stream.

    Sets the default encoding for a writable stream.

    Definition Classes
    Writable
    Example:
    1. writable.setDefaultEncoding(encoding)

  50. def setEncoding(encoding: String): Inflate.this.type

    Permalink

    Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects.

    Call this function to cause the stream to return strings of the specified encoding instead of Buffer objects. For example, if you do readable.setEncoding('utf8'), then the output data will be interpreted as UTF-8 data, and returned as strings. If you do readable.setEncoding('hex'), then the data will be encoded in hexadecimal string format.

    This properly handles multi-byte characters that would otherwise be potentially mangled if you simply pulled the Buffers directly and called buf.toString(encoding) on them. If you want to read the data as strings, always use this method.

    Also you can disable any encoding at all with readable.setEncoding(null). This approach is very useful if you deal with binary data or with large multi-byte strings spread out over multiple chunks.

    Definition Classes
    Readable
    Example:
    1. readable.setEncoding(encoding)

  51. def setMaxListeners(n: Int): Inflate.this.type

    Permalink

    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)

  52. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  53. def toLocaleString(): String

    Permalink
    Definition Classes
    Object
  54. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any
  55. def uncork(): Unit

    Permalink

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

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

    Definition Classes
    Writable
    Example:
    1. writable.uncork()

  56. def unpipe(destination: Writable = js.native): Unit

    Permalink

    This method will remove the hooks set up for a previous stream.pipe() call.

    This method will remove the hooks set up for a previous stream.pipe() call.

    If the destination is not specified, then all pipes are removed.

    If the destination is specified, but no pipe is set up for it, then this is a no-op.

    Definition Classes
    Readable
    Example:
    1. readable.unpipe([destination])

  57. def unshift(chunk: Any): Unit

    Permalink

    This is useful in certain cases where a stream is being consumed by a parser, which needs to "un-consume" some data that it has optimistically pulled out of the source, so that the stream can be passed on to some other party.

    This is useful in certain cases where a stream is being consumed by a parser, which needs to "un-consume" some data that it has optimistically pulled out of the source, so that the stream can be passed on to some other party.

    Note that stream.unshift(chunk) cannot be called after the 'end' event has been triggered; a runtime error will be raised.

    If you find that you must often call stream.unshift(chunk) in your programs, consider implementing a Transform stream instead.

    Definition Classes
    Readable
    Example:
    1. readable.unshift(chunk)

  58. var usingDomains: Boolean

    Permalink
    Definition Classes
    IEventEmitter
  59. def valueOf(): Any

    Permalink
    Definition Classes
    Object
  60. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  61. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  62. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  63. def wrap(stream: Any): Unit

    Permalink

    Versions of Node.js prior to v0.10 had streams that did not implement the entire Streams API as it is today.

    Versions of Node.js prior to v0.10 had streams that did not implement the entire Streams API as it is today. (See Compatibility for more information.)

    If you are using an older Node.js library that emits 'data' events and has a stream.pause() method that is advisory only, then you can use the wrap() method to create a Readable stream that uses the old stream as its data source.

    You will very rarely ever need to call this function, but it exists as a convenience for interacting with old Node.js programs and libraries.

    Definition Classes
    Readable
    Example:
    1. readable.wrap(stream)

  64. def write(chunk: |[Buffer, String], encoding: String, callback: Function1[Error, Any]): Boolean

    Permalink

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

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

    chunk

    The data to write (<String> | <Buffer>)

    encoding

    The encoding, if chunk is a String

    callback

    the Callback for when this chunk of data is flushed

    returns

    true, if the data was handled completely

    Definition Classes
    Writable
    Example:
    1. writable.write(chunk[, encoding][, callback])

  65. def write(chunk: |[Buffer, String], encoding: String): Boolean

    Permalink

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

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

    chunk

    The data to write (<String> | <Buffer>)

    encoding

    The encoding, if chunk is a String

    returns

    true, if the data was handled completely

    Definition Classes
    Writable
    Example:
    1. writable.write(chunk[, encoding][, callback])

  66. def write(chunk: |[Buffer, String], callback: Function1[Error, Any] = js.native): Boolean

    Permalink

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

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

    chunk

    The data to write (<String> | <Buffer>)

    callback

    the Callback for when this chunk of data is flushed

    returns

    true, if the data was handled completely

    Definition Classes
    Writable
    Example:
    1. writable.write(chunk[, encoding][, callback])

Inherited from CompressionAlgorithm

Inherited from Writable

Inherited from Readable

Inherited from IEventEmitter

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped