fs2-io/fs2.internal.jsdeps.node/streamMod

streamMod

object streamMod
class Object
trait Matchable
class Any

Type members

Classlikes

@JSImport("stream", "Duplex") @native @JSType
class Duplex() extends StObject
@native @JSType
trait DuplexOptions extends StObject with ReadableOptions
Companion
object
object DuplexOptions
Companion
class
@native @JSType
trait FinishedOptions extends StObject with Abortable
Companion
object
object FinishedOptions
Companion
class
@JSImport("stream", "PassThrough") @native @JSType
class PassThrough() extends StObject
@native @JSType
trait Pipe extends StObject
Companion
object
object Pipe
Companion
class
@native @JSType
trait PipelineOptions extends StObject
Companion
object
object PipelineOptions
Companion
class
@JSImport("stream", "Readable") @native @JSType
class Readable() extends StObject with ReadableStream
Companion
object
object Readable
Companion
class
@native @JSType
trait ReadableOptions extends StObject with StreamOptions[Readable]
Companion
object
object ReadableOptions
Companion
class
@JSImport("stream", "Stream") @native @JSType
class Stream() extends StObject with StdioNull
@native @JSType
trait StreamOptions[T]() extends StObject with Abortable
Companion
object
object StreamOptions
Companion
class
@JSImport("stream", "Transform") @native @JSType
class Transform() extends StObject
@native @JSType
trait TransformOptions extends StObject with DuplexOptions
Companion
object
object TransformOptions
Companion
class
@JSImport("stream", "Writable") @native @JSType
class Writable() extends StObject with WritableStream
@native @JSType
trait WritableOptions extends StObject with StreamOptions[Writable]
Companion
object
object WritableOptions
Companion
class
@JSImport("stream") @native @JSType
class ^() extends StObject
@native @JSType
trait internal extends StObject
object promises

Types

type PipelineCallback[S] = Function1[ErrnoException | Null, Unit] | Function2[ErrnoException | Null, Any, Unit]
type PipelineDestinationPromiseFunction[T, P] = Function1[AsyncIterable[T], Promise[P]]
type PipelinePromise[S] = Promise[Any | Unit]
type PipelineSourceFunction[T] = Function0[Iterable[T] | AsyncIterable[T]]
type PipelineTransform[S, U] = ReadWriteStream | Function1[S | AsyncIterable[Any], AsyncIterable[U]]
type TransformCallback = Function2[UndefOr[Error | Null], UndefOr[Any], Unit]

Value members

Concrete methods

@inline
def addAbortSignal[T](signal: AbortSignal, stream: T): T

Attaches an AbortSignal to a readable or writeable stream. This lets code control stream destruction using an AbortController.

Attaches an AbortSignal to a readable or writeable stream. This lets code control stream destruction using an AbortController.

Calling abort on the AbortController corresponding to the passed AbortSignal will behave the same way as calling .destroy(new AbortError()) on the stream.

@inline
def finished(stream: ReadWriteStream, callback: Function1[UndefOr[ErrnoException | Null], Unit]): Function0[Unit]
@inline
def finished(stream: ReadWriteStream, options: FinishedOptions, callback: Function1[UndefOr[ErrnoException | Null], Unit]): Function0[Unit]
@inline
def finished(stream: ReadableStream, callback: Function1[UndefOr[ErrnoException | Null], Unit]): Function0[Unit]
@inline
def finished(stream: ReadableStream, options: FinishedOptions, callback: Function1[UndefOr[ErrnoException | Null], Unit]): Function0[Unit]
@inline
def finished(stream: WritableStream, callback: Function1[UndefOr[ErrnoException | Null], Unit]): Function0[Unit]
@inline
def finished(stream: WritableStream, options: FinishedOptions, callback: Function1[UndefOr[ErrnoException | Null], Unit]): Function0[Unit]
@inline
def pipeline(stream1: ReadableStream, stream2: ReadWriteStream, streams: ReadWriteStream | WritableStream | Function1[ErrnoException, Unit]*): WritableStream
@inline
def pipeline(stream1: ReadableStream, stream2: WritableStream, streams: ReadWriteStream | WritableStream | Function1[ErrnoException, Unit]*): WritableStream
@inline
def pipeline(streams: Array[ReadableStream | WritableStream | ReadWriteStream], callback: Function1[ErrnoException | Null, Unit]): WritableStream
@inline
def pipeline[A, B](source: A, destination: B): WritableStream | B
@inline
def pipeline[A, B](source: A, destination: B, callback: PipelineCallback[B]): WritableStream | B
@inline
def pipeline[A, T1, B](source: A, transform1: T1, destination: B): WritableStream | B
@inline
def pipeline[A, T1, B](source: A, transform1: T1, destination: B, callback: PipelineCallback[B]): WritableStream | B
@inline
def pipeline[A, T1, T2, B](source: A, transform1: T1, transform2: T2, destination: B): WritableStream | B
@inline
def pipeline[A, T1, T2, B](source: A, transform1: T1, transform2: T2, destination: B, callback: PipelineCallback[B]): WritableStream | B
@inline
def pipeline[A, T1, T2, T3, B](source: A, transform1: T1, transform2: T2, transform3: T3, destination: B): WritableStream | B
@inline
def pipeline[A, T1, T2, T3, B](source: A, transform1: T1, transform2: T2, transform3: T3, destination: B, callback: PipelineCallback[B]): WritableStream | B
@inline
def pipeline[A, T1, T2, T3, T4, B](source: A, transform1: T1, transform2: T2, transform3: T3, transform4: T4, destination: B): WritableStream | B
@inline
def pipeline[A, T1, T2, T3, T4, B](source: A, transform1: T1, transform2: T2, transform3: T3, transform4: T4, destination: B, callback: PipelineCallback[B]): WritableStream | B

Concrete fields

@JSImport("stream") @native
val ^: Any