Preparing search index...
The search index is not available
bun-types
bun-types
ReadWriteStream
Interface ReadWriteStream
Hierarchy
ReadableStream
WritableStream
ReadWriteStream
Index
Properties
locked
Methods
abort
cancel
close
for
Each
get
Reader
get
Writer
pipe
Through
pipe
To
tee
Properties
Readonly
locked
locked
:
boolean
Methods
abort
abort
(
reason
?:
any
)
:
Promise
<
void
>
Parameters
Optional
reason:
any
Returns
Promise
<
void
>
abort
(
reason
?:
any
)
:
Promise
<
void
>
Parameters
Optional
reason:
any
Returns
Promise
<
void
>
cancel
cancel
(
reason
?:
any
)
:
Promise
<
void
>
Parameters
Optional
reason:
any
Returns
Promise
<
void
>
cancel
(
reason
?:
any
)
:
Promise
<
void
>
Parameters
Optional
reason:
any
Returns
Promise
<
void
>
close
close
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
close
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
for
Each
for
Each
(
callbackfn
:
(
(
value
:
any
, key
:
number
, parent
:
ReadableStream
<
any
>
)
=>
void
)
, thisArg
?:
any
)
:
void
Parameters
callbackfn:
(
(
value
:
any
, key
:
number
, parent
:
ReadableStream
<
any
>
)
=>
void
)
(
value
:
any
, key
:
number
, parent
:
ReadableStream
<
any
>
)
:
void
Parameters
value:
any
key:
number
parent:
ReadableStream
<
any
>
Returns
void
Optional
thisArg:
any
Returns
void
for
Each
(
callbackfn
:
(
(
value
:
any
, key
:
number
, parent
:
ReadableStream
<
any
>
)
=>
void
)
, thisArg
?:
any
)
:
void
Parameters
callbackfn:
(
(
value
:
any
, key
:
number
, parent
:
ReadableStream
<
any
>
)
=>
void
)
(
value
:
any
, key
:
number
, parent
:
ReadableStream
<
any
>
)
:
void
Parameters
value:
any
key:
number
parent:
ReadableStream
<
any
>
Returns
void
Optional
thisArg:
any
Returns
void
get
Reader
get
Reader
(
)
:
ReadableStreamDefaultReader
<
any
>
Returns
ReadableStreamDefaultReader
<
any
>
get
Reader
(
)
:
ReadableStreamDefaultReader
<
any
>
Returns
ReadableStreamDefaultReader
<
any
>
get
Writer
get
Writer
(
)
:
WritableStreamDefaultWriter
<
any
>
Returns
WritableStreamDefaultWriter
<
any
>
get
Writer
(
)
:
WritableStreamDefaultWriter
<
any
>
Returns
WritableStreamDefaultWriter
<
any
>
pipe
Through
pipe
Through
<
T
>
(
transform
:
ReadableWritablePair
<
T
,
any
>
, options
?:
StreamPipeOptions
)
:
ReadableStream
<
T
>
Type Parameters
T
Parameters
transform:
ReadableWritablePair
<
T
,
any
>
Optional
options:
StreamPipeOptions
Returns
ReadableStream
<
T
>
pipe
Through
<
T
>
(
transform
:
ReadableWritablePair
<
T
,
any
>
, options
?:
StreamPipeOptions
)
:
ReadableStream
<
T
>
Type Parameters
T
Parameters
transform:
ReadableWritablePair
<
T
,
any
>
Optional
options:
StreamPipeOptions
Returns
ReadableStream
<
T
>
pipe
To
pipe
To
(
destination
:
WritableStream
<
any
>
, options
?:
StreamPipeOptions
)
:
Promise
<
void
>
Parameters
destination:
WritableStream
<
any
>
Optional
options:
StreamPipeOptions
Returns
Promise
<
void
>
pipe
To
(
destination
:
WritableStream
<
any
>
, options
?:
StreamPipeOptions
)
:
Promise
<
void
>
Parameters
destination:
WritableStream
<
any
>
Optional
options:
StreamPipeOptions
Returns
Promise
<
void
>
tee
tee
(
)
:
[
ReadableStream
<
any
>
,
ReadableStream
<
any
>
]
Returns
[
ReadableStream
<
any
>
,
ReadableStream
<
any
>
]
tee
(
)
:
[
ReadableStream
<
any
>
,
ReadableStream
<
any
>
]
Returns
[
ReadableStream
<
any
>
,
ReadableStream
<
any
>
]
Settings
Member Visibility
Protected
Private
Inherited
External
Theme
OS
Light
Dark
Modules
bun-
types
"assert"
"buffer"
"bun"
"bun:ffi"
"bun:jsc"
"bun:sqlite"
"bun:test"
"constants"
"crypto"
constants
generate
Key
Pair
"domain"
"events"
Event
Emitter
"fs"
constants
realpath
Sync
"fs/promises"
"http"
"https"
"node:assert"
"node:buffer"
"node:constants"
"node:crypto"
constants
generate
Key
Pair
"node:domain"
"node:events"
"node:fs"
constants
realpath
Sync
"node:fs/promises"
"node:http"
"node:https"
"node:os"
constants
errno
priority
signals
"node:path"
"node:path/posix"
"node:path/win32"
"node:process"
"node:punycode"
"node:querystring"
"node:stream"
finished
pipeline
"node:string_
decoder"
"node:sys"
inspect
promisify
"node:timers"
"node:tty"
"node:url"
"node:util"
inspect
promisify
"node:zlib"
brotli
Compress
brotli
Decompress
constants
deflate
deflate
Raw
gunzip
gzip
inflate
inflate
Raw
unzip
"os"
constants
errno
priority
signals
"path"
"path/posix"
"path/win32"
"process"
"punycode"
"querystring"
"stream"
finished
pipeline
"string_
decoder"
"supports-
color"
"sys"
inspect
promisify
"test"
"timers"
"tty"
"url"
"util"
inspect
promisify
"zlib"
brotli
Compress
brotli
Decompress
constants
deflate
deflate
Raw
gunzip
gzip
inflate
inflate
Raw
unzip
HTMLRewriter
Types
Read
Write
Stream
locked
abort
cancel
close
for
Each
get
Reader
get
Writer
pipe
Through
pipe
To
tee
Generated using
TypeDoc