Endo API documentation
Preparing search index...
@endo/stream
Stream
Interface Stream<TRead, TWrite, TReadReturn, TWriteReturn>
interface
Stream
<
TRead
,
TWrite
=
undefined
,
TReadReturn
=
undefined
,
TWriteReturn
=
undefined
,
>
{
"[asyncIterator]"
()
:
Stream
<
TRead
,
TWrite
,
TReadReturn
,
TWriteReturn
>
;
next
(
value
:
TWrite
)
:
Promise
<
IteratorResult
<
TRead
,
TReadReturn
>
>
;
return
(
value
:
TWriteReturn
)
:
Promise
<
IteratorResult
<
TRead
,
TReadReturn
>
>
;
throw
(
error
:
Error
)
:
Promise
<
IteratorResult
<
TRead
,
TReadReturn
>
>
;
}
Type Parameters
TRead
TWrite
=
undefined
TReadReturn
=
undefined
TWriteReturn
=
undefined
Index
Methods
[async
Iterator]
next
return
throw
Methods
[async
Iterator]
"[asyncIterator]"
()
:
Stream
<
TRead
,
TWrite
,
TReadReturn
,
TWriteReturn
>
Returns
Stream
<
TRead
,
TWrite
,
TReadReturn
,
TWriteReturn
>
next
next
(
value
:
TWrite
)
:
Promise
<
IteratorResult
<
TRead
,
TReadReturn
>
>
Parameters
value
:
TWrite
Returns
Promise
<
IteratorResult
<
TRead
,
TReadReturn
>
>
return
return
(
value
:
TWriteReturn
)
:
Promise
<
IteratorResult
<
TRead
,
TReadReturn
>
>
Parameters
value
:
TWriteReturn
Returns
Promise
<
IteratorResult
<
TRead
,
TReadReturn
>
>
throw
throw
(
error
:
Error
)
:
Promise
<
IteratorResult
<
TRead
,
TReadReturn
>
>
Parameters
error
:
Error
Returns
Promise
<
IteratorResult
<
TRead
,
TReadReturn
>
>
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
[async
Iterator]
next
return
throw
Endo API documentation
Loading...