Skip to content
File

Blob: src/node/internal/streams_readable.d.ts

typescript62 lines
1// Copyright (c) 2017-2022 Cloudflare, Inc.
2// Licensed under the Apache 2.0 license found in the LICENSE file or at:
3// https://opensource.org/licenses/Apache-2.0
4 
5import { Readable as _Readable, Duplex } from 'node:stream';
6import type EventEmitter from 'node:events';
7import {
8 kState,
9 kIsWritable,
10 kIsReadable,
11 kIsClosedPromise,
12 kIsDestroyed,
13} from 'node-internal:streams_util';
14 
15export declare class ReadableState {
16 readable?: boolean;
17 ended?: boolean;
18 endEmitted?: boolean;
19 reading?: boolean;
20 constructed?: boolean;
21 closed?: boolean;
22 closeEmitted?: boolean;
23 destroyed?: boolean;
24 errored?: Error | null;
25 errorEmitted?: boolean;
26 length?: number;
27 highWaterMark?: number;
28 autoDestroy?: boolean;
29 emitClose?: boolean;
30 readingMore?: boolean;
31 readableDidRead?: boolean;
32 readableAborted?: boolean;
33 [kState]: number;
34}
35 
36export declare class Readable extends _Readable {
37 _readableState: ReadableState;
38 _writableState: undefined;
39 _closed: boolean;
40 errored?: Error | null;
41 writableErrored: boolean;
42 readableErrored: boolean;
43 writableFinished: undefined;
44 readableFinished?: boolean;
45 readable: boolean;
46 writable?: boolean;
47 aborted?: boolean;
48 req?: EventEmitter;
49 
50 writableEnded?: boolean;
51 
52 [kIsWritable]: boolean;
53 [kIsReadable]: boolean;
54 [kIsClosedPromise]: Promise<unknown>;
55 [kIsDestroyed]: boolean;
56}
57 
58export const from: typeof Duplex.from;
59export const fromWeb: typeof Duplex.fromWeb;
60export const toWeb: typeof Duplex.toWeb;
61export const wrap: typeof Duplex.wrap;