File size: 5,626 Bytes
bf237c2 |
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 |
import EventEmitter, { EventMap } from 'bare-events'
import Buffer, { BufferEncoding } from 'bare-buffer'
type StreamEncoding = BufferEncoding | 'buffer'
interface StreamCallback {
(err: Error | null): void
}
interface StreamEvents extends EventMap {
close: []
error: [err: Error]
}
interface StreamOptions<S extends Stream = Stream> {
eagerOpen?: boolean
signal?: AbortSignal
open?(this: S, cb: StreamCallback): void
predestroy?(this: S): void
destroy?(this: S, err: Error | null, cb: StreamCallback): void
}
interface Stream<M extends StreamEvents = StreamEvents>
extends EventEmitter<M> {
_open(cb: StreamCallback): void
_predestroy(): void
_destroy(err: Error | null, cb: StreamCallback): void
readonly readable: boolean
readonly writable: boolean
readonly destroyed: boolean
readonly destroying: boolean
destroy(err?: Error | null): void
}
declare class Stream {}
interface ReadableEvents extends StreamEvents {
data: [data: unknown]
end: []
readable: []
piping: [dest: Writable]
}
interface ReadableOptions<S extends Readable = Readable>
extends StreamOptions<S> {
encoding?: BufferEncoding
highWaterMark?: number
read?(this: S, size: number): void
}
interface Readable<M extends ReadableEvents = ReadableEvents>
extends Stream<M>,
AsyncIterable<unknown> {
_read(size: number): void
push(data: unknown | null, encoding?: BufferEncoding): boolean
unshift(data: unknown | null, encoding?: BufferEncoding): boolean
read(): unknown | null
resume(): this
pause(): this
pipe<S extends Writable>(dest: S, cb?: StreamCallback): S
setEncoding(encoding: BufferEncoding): void
}
declare class Readable<
M extends ReadableEvents = ReadableEvents
> extends Stream<M> {
constructor(opts?: ReadableOptions)
static from(
data: unknown | unknown[] | AsyncIterable<unknown>,
opts?: ReadableOptions
): Readable
static isBackpressured(rs: Readable): boolean
static isPaused(rs: Readable): boolean
}
interface WritableEvents extends StreamEvents {
drain: []
finish: []
pipe: [src: Readable]
}
interface WritableOptions<S extends Writable = Writable>
extends StreamOptions<S> {
write?(
this: S,
data: unknown,
encoding: StreamEncoding,
cb: StreamCallback
): void
writev?(
this: S,
batch: { chunk: unknown; encoding: StreamEncoding }[],
cb: StreamCallback
): void
final?(this: S, cb: StreamCallback): void
}
interface Writable<M extends WritableEvents = WritableEvents>
extends Stream<M> {
_write(data: unknown, encoding: StreamEncoding, cb: StreamCallback): void
_writev(
batch: { chunk: unknown; encoding: StreamEncoding }[],
cb: StreamCallback
): void
_final(cb: StreamCallback): void
readonly destroyed: boolean
write(data: unknown, encoding?: BufferEncoding, cb?: StreamCallback): boolean
write(data: unknown, cb?: StreamCallback): boolean
end(cb?: StreamCallback): this
end(data: unknown, encoding?: BufferEncoding, cb?: StreamCallback): this
end(data: unknown, cb?: StreamCallback): this
cork(): void
uncork(): void
}
declare class Writable<
M extends WritableEvents = WritableEvents
> extends Stream<M> {
constructor(opts?: WritableOptions)
static isBackpressured(ws: Writable): boolean
static drained(ws: Writable): Promise<boolean>
}
interface DuplexEvents extends ReadableEvents, WritableEvents {}
interface DuplexOptions<S extends Duplex = Duplex>
extends ReadableOptions<S>,
WritableOptions<S> {}
interface Duplex<M extends DuplexEvents = DuplexEvents>
extends Readable<M>,
Writable<M> {}
declare class Duplex<M extends DuplexEvents = DuplexEvents> extends Stream<M> {
constructor(opts?: DuplexOptions)
}
interface TransformEvents extends DuplexEvents {}
interface TransformOptions<S extends Transform = Transform>
extends DuplexOptions<S> {
transform?(
this: S,
data: unknown,
encoding: StreamEncoding,
cb: StreamCallback
): void
flush?(this: S, cb: StreamCallback): void
}
interface Transform<M extends TransformEvents = TransformEvents>
extends Duplex<M> {
_transform(data: unknown, encoding: StreamEncoding, cb: StreamCallback): void
_flush(cb: StreamCallback): void
}
declare class Transform<
M extends TransformEvents = TransformEvents
> extends Duplex<M> {
constructor(opts?: TransformOptions)
}
type Pipeline<S extends Writable> = [
src: Readable,
...transforms: Duplex[],
dest: S
]
declare namespace Stream {
export {
Stream,
StreamEvents,
StreamOptions,
Readable,
ReadableEvents,
ReadableOptions,
Writable,
WritableEvents,
WritableOptions,
Duplex,
DuplexEvents,
DuplexOptions,
Transform,
TransformEvents,
TransformOptions,
Transform as PassThrough
}
export function pipeline<S extends Writable>(
streams: Pipeline<S>,
cb?: StreamCallback
): S
export function pipeline<S extends Writable>(...args: Pipeline<S>): S
export function pipeline<S extends Writable>(
...args: [...Pipeline<S>, cb: StreamCallback]
): S
export function finished(
stream: Stream,
opts: { cleanup?: boolean },
cb: StreamCallback
): () => void
export function finished(stream: Stream, cb: StreamCallback): () => void
export function isStream(stream: unknown): stream is Stream
export function isEnded(stream: Stream): boolean
export function isFinished(stream: Stream): boolean
export function isDisturbed(stream: Stream): boolean
export function getStreamError(
stream: Stream,
opts?: { all?: boolean }
): Error | null
}
export = Stream
|