trait Zlib extends Object with IEventEmitter with UncategorizedConstants with ZlibConstants
This provides bindings to Gzip/Gunzip, Deflate/Inflate, and DeflateRaw/InflateRaw classes. Each class takes the same options, and is a readable/writable Stream.
- Annotations
- @RawJSType() @native()
- See also
https://nodejs.org/docs/latest/api/zlib.html
- Alphabetic
- By Inheritance
- Zlib
- ZlibConstants
- UncategorizedConstants
- IEventEmitter
- Object
- Any
- AnyRef
- Any
- Hide All
- Show All
- Public
- Protected
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- val DEFLATE: Int
- Definition Classes
- UncategorizedConstants
- val DEFLATERAW: Int
- Definition Classes
- UncategorizedConstants
- val GUNZIP: Int
- Definition Classes
- UncategorizedConstants
- val GZIP: Int
- Definition Classes
- UncategorizedConstants
- val INFLATE: Int
- Definition Classes
- UncategorizedConstants
- val INFLATERAW: Int
- Definition Classes
- UncategorizedConstants
- val UNZIP: Int
- Definition Classes
- UncategorizedConstants
- val ZLIB_VERNUM: Int
- Definition Classes
- UncategorizedConstants
- val Z_ASCII: DataType
- Definition Classes
- ZlibConstants
- val Z_BEST_COMPRESSION: CompressionLevel
- Definition Classes
- ZlibConstants
- val Z_BEST_SPEED: CompressionLevel
- Definition Classes
- ZlibConstants
- val Z_BINARY: DataType
- Definition Classes
- ZlibConstants
- val Z_BLOCK: CompressionFlush
- Definition Classes
- ZlibConstants
- val Z_BUF_ERROR: CompressionFunction
- Definition Classes
- ZlibConstants
- val Z_DATA_ERROR: CompressionFunction
- Definition Classes
- ZlibConstants
- val Z_DEFAULT_CHUNK: Int
- Definition Classes
- ZlibConstants
- val Z_DEFAULT_COMPRESSION: CompressionLevel
- Definition Classes
- ZlibConstants
- val Z_DEFAULT_LEVEL: Int
- Definition Classes
- ZlibConstants
- val Z_DEFAULT_MEMLEVEL: Int
- Definition Classes
- ZlibConstants
- val Z_DEFAULT_STRATEGY: CompressionStrategy
- Definition Classes
- ZlibConstants
- val Z_DEFAULT_WINDOWBITS: Int
- Definition Classes
- ZlibConstants
- val Z_DEFLATED: DeflateCompressMethod
- Definition Classes
- ZlibConstants
- val Z_ERRNO: CompressionFunction
- Definition Classes
- ZlibConstants
- val Z_FILTERED: CompressionStrategy
- Definition Classes
- ZlibConstants
- val Z_FINISH: CompressionFlush
- Definition Classes
- ZlibConstants
- val Z_FIXED: CompressionStrategy
- Definition Classes
- ZlibConstants
- val Z_FULL_FLUSH: CompressionFlush
- Definition Classes
- ZlibConstants
- val Z_HUFFMAN_ONLY: CompressionStrategy
- Definition Classes
- ZlibConstants
- val Z_MAX_CHUNK: Double
- Definition Classes
- ZlibConstants
- val Z_MAX_LEVEL: Int
- Definition Classes
- ZlibConstants
- val Z_MAX_MEMLEVEL: Int
- Definition Classes
- ZlibConstants
- val Z_MAX_WINDOWBITS: Int
- Definition Classes
- ZlibConstants
- val Z_MEM_ERROR: CompressionFunction
- Definition Classes
- ZlibConstants
- val Z_MIN_CHUNK: Int
- Definition Classes
- ZlibConstants
- val Z_MIN_LEVEL: Int
- Definition Classes
- ZlibConstants
- val Z_MIN_MEMLEVEL: Int
- Definition Classes
- ZlibConstants
- val Z_MIN_WINDOWBITS: Int
- Definition Classes
- ZlibConstants
- val Z_NEED_DICT: CompressionFunction
- Definition Classes
- ZlibConstants
- val Z_NO_COMPRESSION: CompressionLevel
- Definition Classes
- ZlibConstants
- val Z_NO_FLUSH: CompressionFlush
- Definition Classes
- ZlibConstants
- val Z_NULL: AllocationType
- Definition Classes
- ZlibConstants
- val Z_OK: CompressionFunction
- Definition Classes
- ZlibConstants
- val Z_PARTIAL_FLUSH: CompressionFlush
- Definition Classes
- ZlibConstants
- val Z_RLE: CompressionStrategy
- Definition Classes
- ZlibConstants
- val Z_STREAM_END: CompressionFunction
- Definition Classes
- ZlibConstants
- val Z_STREAM_ERROR: CompressionFunction
- Definition Classes
- ZlibConstants
- val Z_SYNC_FLUSH: CompressionFlush
- Definition Classes
- ZlibConstants
- val Z_TEXT: DataType
- Definition Classes
- ZlibConstants
- val Z_TREES: CompressionFlush
- Definition Classes
- ZlibConstants
- val Z_UNKNOWN: DataType
- Definition Classes
- ZlibConstants
- val Z_VERSION_ERROR: CompressionFunction
- Definition Classes
- ZlibConstants
- def addListener(eventName: String, listener: Function): Zlib.this.type
Alias for emitter.on(eventName, listener).
Alias for emitter.on(eventName, listener).
- Definition Classes
- IEventEmitter
emitter.addListener(eventName, listener)
- See also
on()
Example: - final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native() @HotSpotIntrinsicCandidate()
- def createDeflate(options: CompressionOptions): Deflate
Returns a new Deflate object with an options.
Returns a new Deflate object with an options.
zlib.createDeflate(options)
Example: - def createDeflateRaw(options: CompressionOptions = js.native): DeflateRaw
Returns a new DeflateRaw object with an options.
Returns a new DeflateRaw object with an options.
zlib.createDeflateRaw(options)
Example: - def createGunzip(options: CompressionOptions = js.native): Gunzip
Returns a new Gunzip object with an options.
Returns a new Gunzip object with an options.
zlib.createGunzip(options)
Example: - def createGzip(options: CompressionOptions = js.native): Gzip
Returns a new Gzip object with an options.
Returns a new Gzip object with an options.
zlib.createGzip(options)
Example: - def createInflate(options: CompressionOptions = js.native): Inflate
Returns a new Inflate object with an options.
Returns a new Inflate object with an options.
zlib.createInflate(options)
Example: - def createInflateRaw(options: CompressionOptions = js.native): InflateRaw
Returns a new InflateRaw object with an options.
Returns a new InflateRaw object with an options.
zlib.createInflateRaw(options)
Example: - def createUnzip(options: CompressionOptions = js.native): Unzip
Returns a new Unzip object with an options.
Returns a new Unzip object with an options.
zlib.createUnzip(options)
Example: - def deflate(buffer: Data, callback: Function): Unit
- def deflate(buffer: Data, options: CompressionOptions, callback: Function): Unit
Compress a Buffer or string with Deflate.
Compress a Buffer or string with Deflate.
zlib.deflate(buf[, options], callback)
Example: - def deflateRaw(buffer: Data, callback: Function): Unit
- def deflateRaw(buffer: Data, options: CompressionOptions, callback: Function): Unit
Compress a Buffer or string with DeflateRaw.
Compress a Buffer or string with DeflateRaw.
zlib.deflateRaw(buf[, options], callback)
Example: - def deflateRawSync(buffer: Data, options: CompressionOptions = js.native): Unit
- def deflateSync(buffer: Data, options: CompressionOptions = js.native): Unit
Compress a Buffer or string with Deflate.
Compress a Buffer or string with Deflate.
zlib.deflateSync(buf[, options])
Example: - val domain: String
- Definition Classes
- IEventEmitter
- 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
emitter.emit(name[, arg1][, arg2][, ...])
Example: - final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def eventNames(): Array[String]
- Definition Classes
- IEventEmitter
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- 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
emitter.getMaxListeners()
- See also
setMaxListeners()
Example: - def gunzip(buffer: Data, callback: Function): Unit
- def gunzip(buffer: Data, options: CompressionOptions, callback: Function): Unit
Decompress a Buffer or string with Gunzip.
Decompress a Buffer or string with Gunzip.
zlib.gunzip(buf[, options], callback)
Example: - def gunzipSync(buffer: Data, options: CompressionOptions = js.native): Unit
Decompress a Buffer or string with Gunzip.
Decompress a Buffer or string with Gunzip.
zlib.gunzipSync(buf[, options])
Example: - def gzip(buffer: Data, callback: Function): Unit
- def gzip(buffer: Data, options: CompressionOptions, callback: Function): Unit
Compress a Buffer or string with Gzip.
Compress a Buffer or string with Gzip.
zlib.gzip(buf[, options], callback)
Example: - def gzipSync(buffer: Data, options: CompressionOptions = js.native): Unit
Compress a Buffer or string with Gzip.
Compress a Buffer or string with Gzip.
zlib.gzipSync(buf[, options])
Example: - def hasOwnProperty(v: String): Boolean
- Definition Classes
- Object
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def inflate(buffer: Data, callback: Function): Unit
- def inflate(buffer: Data, options: CompressionOptions, callback: Function): Unit
Decompress a Buffer or string with Inflate.
Decompress a Buffer or string with Inflate.
zlib.inflate(buf[, options], callback)
Example: - def inflateRaw(buffer: Data, callback: Function): Unit
- def inflateRaw(buffer: Data, options: CompressionOptions, callback: Function): Unit
Decompress a Buffer or string with InflateRaw.
Decompress a Buffer or string with InflateRaw.
zlib.inflateRaw(buf[, options], callback)
Example: - def inflateRawSync(buffer: Data, options: CompressionOptions = js.native): Unit
Decompress a Buffer or string with InflateRaw.
Decompress a Buffer or string with InflateRaw.
zlib.inflateRawSync(buf[, options])
Example: - def inflateSync(buffer: Data, options: CompressionOptions = js.native): Unit
Decompress a Buffer or string with Inflate.
Decompress a Buffer or string with Inflate.
zlib.inflateSync(buf[, options])
Example: - final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- def isPrototypeOf(v: Object): Boolean
- Definition Classes
- Object
- 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
emitter.listenerCount(eventName)
Example: - 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
emitter.listeners(eventName)
Example: - final def ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- final def notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- final def notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
- def on(eventName: String, listener: Function): Zlib.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
emitter.on(eventName, listener)
Example: - def once(eventName: String, listener: Function): Zlib.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
emitter.once(eventName, listener)
Example: - def prependListener(eventName: String, listener: Function): Zlib.this.type
- Definition Classes
- IEventEmitter
- def prependOnceListener(eventName: String, listener: Function): Zlib.this.type
- Definition Classes
- IEventEmitter
- def propertyIsEnumerable(v: String): Boolean
- Definition Classes
- Object
- def removeAllListeners(eventName: String = js.native): Zlib.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
emitter.removeAllListeners([eventName])
Example: - def removeListener(eventName: String, listener: Function): Zlib.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
emitter.removeListener(eventName, listener)
Example: - def setMaxListeners(n: Int): Zlib.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
emitter.setMaxListeners(n)
Example: - final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toLocaleString(): String
- Definition Classes
- Object
- def toString(): String
- Definition Classes
- AnyRef → Any
- def unzip(buffer: Data, callback: Function): Unit
- def unzip(buffer: Data, options: CompressionOptions, callback: Function): Unit
Decompress a Buffer or string with Unzip.
Decompress a Buffer or string with Unzip.
zlib.unzip(buf[, options], callback)
Example: - def unzipSync(buffer: Data, options: CompressionOptions = js.native): Unit
Decompress a Buffer or string with Unzip.
Decompress a Buffer or string with Unzip.
zlib.unzipSync(buf[, options])
Example: - val usingDomains: Boolean
- Definition Classes
- IEventEmitter
- def valueOf(): Any
- Definition Classes
- Object
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])