Package-level declarations

Types

Link copied to clipboard
interface Duplex : Stream
Link copied to clipboard
interface Readable : StatefulStream, EventEmitter, EventTarget, ProxyObject, ProxyIterable

A Readable stream is an abstraction for a source from which data is consumed; an example of a Readable stream is the response object returned by http.get(), or the input stream provided to a running program.

Link copied to clipboard
data class ReadableComposeOptions(var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.compose method.

Link copied to clipboard
data class ReadableDropOptions(var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.drop method.

Link copied to clipboard
data class ReadableEveryOptions(var concurrency: Int = 1, var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.every method.

Link copied to clipboard
data class ReadableFindOptions(var concurrency: Int = 1, var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.find method.

Link copied to clipboard
data class ReadableFlatMapOptions(var concurrency: Int = 1, var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.every method.

Link copied to clipboard
data class ReadableForEachOptions(var concurrency: Int = 1, var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.forEach method.

Link copied to clipboard
data class ReadableFromOptions(var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.from static method.

Link copied to clipboard
data class ReadableIteratorOptions(var destroyOnReturn: Boolean = true)

Defines the structure of options which relate to the Readable.iterator method.

Link copied to clipboard
data class ReadableMapOptions(var concurrency: Int = 1, var highWaterMark: Int = concurrency * 2 - 1, var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.map method.

Link copied to clipboard
data class ReadablePipeOptions(var end: Boolean = true)

Defines the structure of options which relate to the Readable.pipe method.

Link copied to clipboard
data class ReadableReduceOptions(var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.reduce method.

Link copied to clipboard
data class ReadableSomeOptions(var concurrency: Int = 1, var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.some method.

Link copied to clipboard
data class ReadableTakeOptions(var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.take method.

Link copied to clipboard
data class ReadableToArrayOptions(var signal: AbortSignal? = null)

Defines the structure of options which relate to the Readable.toArray method.

Link copied to clipboard
Link copied to clipboard
interface Stream
Link copied to clipboard
typealias StreamChunk = Any

This type is typically used when consuming chunks from a stream, or emitting chunks to a stream.

Link copied to clipboard

This type is typically returned from Readable.read and friends.

Link copied to clipboard
interface Transform : Duplex
Link copied to clipboard