Github
Preparing search index...
The search index is not available
Documentation
Documentation
@web3-storage/upload-client
CAR
BlockStream
Class BlockStream
Hierarchy
ReadableStream
BlockStream
Index
Constructors
constructor
Properties
get
Roots
locked
Methods
cancel
get
Reader
pipe
Through
pipe
To
tee
Constructors
constructor
new
Block
Stream
(
car
)
:
BlockStream
Parameters
car
:
BlobLike
Returns
BlockStream
Properties
get
Roots
get
Roots
:
(
(
)
=>
Promise
<
AnyLink
[]
>
)
Type declaration
(
)
:
Promise
<
AnyLink
[]
>
Returns
Promise
<
AnyLink
[]
>
Readonly
locked
locked
:
boolean
MDN Reference
Methods
cancel
cancel
(
reason
?
)
:
Promise
<
void
>
MDN Reference
Parameters
Optional
reason
:
any
Returns
Promise
<
void
>
get
Reader
get
Reader
(
options
)
:
ReadableStreamBYOBReader
MDN Reference
Parameters
options
:
{
mode
:
"byob"
;
}
mode
:
"byob"
Returns
ReadableStreamBYOBReader
get
Reader
(
)
:
ReadableStreamDefaultReader
<
Block
<
any
,
number
,
number
,
Version
>
>
Returns
ReadableStreamDefaultReader
<
Block
<
any
,
number
,
number
,
Version
>
>
get
Reader
(
options
?
)
:
ReadableStreamReader
<
Block
<
any
,
number
,
number
,
Version
>
>
Parameters
Optional
options
:
ReadableStreamGetReaderOptions
Returns
ReadableStreamReader
<
Block
<
any
,
number
,
number
,
Version
>
>
pipe
Through
pipe
Through
<
T
>
(
transform
,
options
?
)
:
ReadableStream
<
T
>
MDN Reference
Type Parameters
T
Parameters
transform
:
ReadableWritablePair
<
T
,
Block
<
any
,
number
,
number
,
Version
>
>
Optional
options
:
StreamPipeOptions
Returns
ReadableStream
<
T
>
pipe
To
pipe
To
(
destination
,
options
?
)
:
Promise
<
void
>
MDN Reference
Parameters
destination
:
WritableStream
<
Block
<
any
,
number
,
number
,
Version
>
>
Optional
options
:
StreamPipeOptions
Returns
Promise
<
void
>
tee
tee
(
)
:
[
ReadableStream
<
Block
<
any
,
number
,
number
,
Version
>
>
,
ReadableStream
<
Block
<
any
,
number
,
number
,
Version
>
>
]
MDN Reference
Returns
[
ReadableStream
<
Block
<
any
,
number
,
number
,
Version
>
>
,
ReadableStream
<
Block
<
any
,
number
,
number
,
Version
>
>
]
Settings
Member Visibility
Protected
Private
Inherited
Theme
OS
Light
Dark
On This Page
constructor
get
Roots
locked
cancel
get
Reader
pipe
Through
pipe
To
tee
Documentation
@web3-storage/access
@web3-storage/capabilities
@web3-storage/upload-client
@web3-storage/filecoin-client
@web3-storage/w3up-client
Generated using
TypeDoc
MDN Reference