Packages

class Gzip extends Transform with ZlibBase

Compress data using gzip.

Annotations
@JSType() @native() @JSImport("zlib", "Gzip")
Linear Supertypes
ZlibBase, Transform, ITransform, IDuplex, IWritable, IReadable, LegacyStream, IEventEmitter, Stream, Object, Any, AnyRef, Any
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Gzip
  2. ZlibBase
  3. Transform
  4. ITransform
  5. IDuplex
  6. IWritable
  7. IReadable
  8. LegacyStream
  9. IEventEmitter
  10. Stream
  11. Object
  12. Any
  13. AnyRef
  14. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. Protected

Instance Constructors

  1. new Gzip()

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): Gzip.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
    Definition Classes
    ZlibBase
  7. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  8. def close(): Unit
    Definition Classes
    ZlibBase
  9. def close(callback: Function): Unit
    Definition Classes
    ZlibBase
  10. 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()

  11. def destroy(): Unit
    Definition Classes
    IWritable
  12. def destroy(error: Error): Unit
    Definition Classes
    IWritable
  13. def destroyed: Boolean
    Definition Classes
    IDuplex → IWritable → IReadable
  14. val domain: Domain
    Definition Classes
    IEventEmitter
  15. 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][, ...])

  16. def end(): Gzip.this.type
    Definition Classes
    IWritable
  17. def end(callback: Function1[Error, Any]): Gzip.this.type
    Definition Classes
    IWritable
  18. def end(chunk: String, encoding: String): Gzip.this.type
    Definition Classes
    IWritable
  19. def end(chunk: String, encoding: String, callback: Function1[Error, Any]): Gzip.this.type
    Definition Classes
    IWritable
  20. def end(chunk: Uint8Array): Gzip.this.type
    Definition Classes
    IWritable
  21. def end(chunk: String): Gzip.this.type
    Definition Classes
    IWritable
  22. def end(chunk: Uint8Array, callback: Function1[Error, Any]): Gzip.this.type
    Definition Classes
    IWritable
  23. def end(chunk: String, callback: Function1[Error, Any]): Gzip.this.type
    Definition Classes
    IWritable
  24. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  25. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  26. def eventNames(): Array[String]
    Definition Classes
    IEventEmitter
  27. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  28. def flush(callback: Function): Unit
    Definition Classes
    ZlibBase
  29. def flush(kind: CompressionFlush, callback: Function): Unit
    Definition Classes
    ZlibBase
  30. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  31. 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()

  32. def hasOwnProperty(v: String): Boolean
    Definition Classes
    Object
  33. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  34. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  35. def isPaused(): Boolean

    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
    IReadable
    Example:

    1. readable.isPaused()

  36. def isPrototypeOf(v: Object): Boolean
    Definition Classes
    Object
  37. 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)

  38. 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)

  39. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  40. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  41. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  42. def off(eventName: String, listner: Function): Gzip.this.type
    Definition Classes
    IEventEmitter
  43. def on(eventName: String, listener: Function): Gzip.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)

  44. def once(eventName: String, listener: Function): Gzip.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)

  45. def params(level: CompressionLevel, strategy: CompressionStrategy, callback: Function): Unit
    Definition Classes
    ZlibBase
  46. def pause(): Gzip.this.type

    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
    IReadable
    Example:

    1. readable.pause()

  47. def pipe(destination: IWritable): Gzip.this.type
    Definition Classes
    IReadable
  48. def pipe(destination: IWritable, options: ReadablePipeOptions): Gzip.this.type

    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
    IReadable
    Example:

    1. readable.pipe(destination[, options])

  49. def prependListener(eventName: String, listener: Function): Gzip.this.type
    Definition Classes
    IEventEmitter
  50. def prependOnceListener(eventName: String, listener: Function): Gzip.this.type
    Definition Classes
    IEventEmitter
  51. def propertyIsEnumerable(v: String): Boolean
    Definition Classes
    Object
  52. def push(chunk: Uint8Array): Boolean

    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
    IReadable
  53. def push(chunk: String): Boolean
    Definition Classes
    IReadable
  54. def push(chunk: String, encoding: String): Boolean

    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
    IReadable
  55. def rawListeners(eventName: String): Array[Function]
    Definition Classes
    IEventEmitter
  56. def readAsBuffer(): Buffer
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  57. def readAsBuffer(size: Int): Buffer
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  58. def readAsObject(): Any
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  59. def readAsObject(size: Int): Any
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  60. def readAsString(): String
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  61. def readAsString(size: Int): String
    Definition Classes
    IReadable
    Annotations
    @JSName("read")
  62. def readable: Boolean
    Definition Classes
    IReadable
  63. def readableEncoding: String
    Definition Classes
    IReadable
  64. def readableEnded: Boolean
    Definition Classes
    IReadable
  65. def readableFlowing: |[Boolean, Null]
    Definition Classes
    IReadable
  66. def readableHighWaterMark: Double
    Definition Classes
    IReadable
  67. def readableLength: Int
    Definition Classes
    IReadable
  68. def readableObjectMode: Boolean
    Definition Classes
    IReadable
  69. def removeAllListeners(): Gzip.this.type
    Definition Classes
    IEventEmitter
  70. def removeAllListeners(eventName: String): Gzip.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])

  71. def removeListener(eventName: String, listener: Function): Gzip.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)

  72. def reset(): Unit
    Definition Classes
    ZlibBase
  73. def resume(): Gzip.this.type

    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
    IReadable
    Example:

    1. readable.resume()

  74. def setDefaultEncoding(encoding: String): Gzip.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)

  75. def setEncoding(encoding: String): Gzip.this.type

    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
    IReadable
    Example:

    1. readable.setEncoding(encoding)

  76. def setMaxListeners(n: Int): Gzip.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)

  77. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  78. def toLocaleString(): String
    Definition Classes
    Object
  79. def toString(): String
    Definition Classes
    AnyRef → Any
  80. 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()

  81. def unpipe(): Unit
    Definition Classes
    IReadable
  82. def unpipe(destination: IWritable): Unit

    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
    IReadable
    Example:

    1. readable.unpipe([destination])

  83. def unshift(chunk: Uint8Array): Unit
    Definition Classes
    IReadable
  84. def unshift(chunk: String): Unit

    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
    IReadable
    Example:

    1. readable.unshift(chunk)

  85. def valueOf(): Any
    Definition Classes
    Object
  86. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  87. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  88. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  89. def wrap(stream: LegacyStream): Unit

    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
    IReadable
    Example:

    1. readable.wrap(stream)

  90. def writable: Boolean
    Definition Classes
    IWritable
  91. def writableCorked: Int
    Definition Classes
    IWritable
  92. def writableEnded: Boolean
    Definition Classes
    IWritable
  93. def writableFinished: Boolean
    Definition Classes
    IWritable
  94. def writableHighWaterMark: Double
    Definition Classes
    IWritable
  95. def writableLength: Int
    Definition Classes
    IWritable
  96. def writableObjectMode: Boolean
    Definition Classes
    IWritable
  97. def write(chunk: String, encoding: String, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable
  98. def write(chunk: String, encoding: String): Boolean
    Definition Classes
    IWritable
  99. def write(chunk: String): Boolean
    Definition Classes
    IWritable
  100. def write(chunk: String, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable
  101. def write(chunk: Uint8Array): Boolean
    Definition Classes
    IWritable
  102. def write(chunk: Uint8Array, callback: Function1[Error, Any]): Boolean
    Definition Classes
    IWritable

Inherited from ZlibBase

Inherited from Transform

Inherited from ITransform

Inherited from IDuplex

Inherited from IWritable

Inherited from IReadable

Inherited from LegacyStream

Inherited from IEventEmitter

Inherited from Stream

Inherited from Object

Inherited from Any

Inherited from AnyRef

Inherited from Any

Ungrouped