A11 TypeScript API - v0.7.26
A11 guides
Python API
C++ internals
Preparing search index...
GraphNode
Class GraphNode
A typed value stream whose reader and writer are C++ AsyncNode objects.
Index
Constructors
constructor
Methods
[async
Iterator]
abort
With
Status
cancel
cancel
Reader
cancel
Writer
close
consume
finalize
get
Id
get
Reader
Options
get
Reader
Status
get
Writer
Abort
Status
get
Writer
Options
get
Writer
Status
is
Writable
next
next
Chunk
next
Fragment
put
put
Chunk
put
Fragment
ref
reset
Reader
set
Reader
Options
set
Writer
Options
state
values
wait
For
Buffer
To
Drain
create
Constructors
constructor
new
GraphNode
(
binding
:
NodeBinding
)
:
GraphNode
Parameters
binding
:
NodeBinding
Returns
GraphNode
Methods
[async
Iterator]
"[asyncIterator]"
()
:
AsyncGenerator
<
unknown
,
void
,
void
>
Returns
AsyncGenerator
<
unknown
,
void
,
void
>
abort
With
Status
abortWithStatus
(
status
:
Status
)
:
Promise
<
Status
>
Parameters
status
:
Status
Returns
Promise
<
Status
>
cancel
cancel
()
:
Promise
<
Status
>
Returns
Promise
<
Status
>
cancel
Reader
cancelReader
()
:
Promise
<
Status
>
Returns
Promise
<
Status
>
cancel
Writer
cancelWriter
()
:
Promise
<
Status
>
Returns
Promise
<
Status
>
close
close
()
:
Promise
<
Status
>
Returns
Promise
<
Status
>
consume
consume
<
T
=
unknown
>
(
options
?:
{
allowNone
?:
boolean
;
timeoutMs
?:
number
}
,
)
:
Promise
<
StatusOr
<
T
|
null
>
>
Type Parameters
T
=
unknown
Parameters
options
:
{
allowNone
?:
boolean
;
timeoutMs
?:
number
}
= {}
Returns
Promise
<
StatusOr
<
T
|
null
>
>
finalize
finalize
(
value
?:
unknown
,
options
?:
{
close
?:
boolean
;
mimetype
?:
string
;
seq
?:
number
;
wait
?:
boolean
;
}
,
)
:
Promise
<
Status
>
Parameters
Optional
value
:
unknown
options
:
{
close
?:
boolean
;
mimetype
?:
string
;
seq
?:
number
;
wait
?:
boolean
}
= {}
Returns
Promise
<
Status
>
get
Id
getId
()
:
string
Returns
string
get
Reader
Options
getReaderOptions
()
:
Promise
<
StatusOr
<
ChunkStoreReaderOptions
>
>
Returns
Promise
<
StatusOr
<
ChunkStoreReaderOptions
>
>
get
Reader
Status
getReaderStatus
()
:
Promise
<
Status
>
Returns
Promise
<
Status
>
get
Writer
Abort
Status
getWriterAbortStatus
()
:
Promise
<
Status
|
null
>
Returns
Promise
<
Status
|
null
>
get
Writer
Options
getWriterOptions
()
:
Promise
<
StatusOr
<
ChunkStoreWriterOptions
>
>
Returns
Promise
<
StatusOr
<
ChunkStoreWriterOptions
>
>
get
Writer
Status
getWriterStatus
()
:
Promise
<
Status
>
Returns
Promise
<
Status
>
is
Writable
isWritable
()
:
Promise
<
StatusOr
<
boolean
>
>
Returns
Promise
<
StatusOr
<
boolean
>
>
next
next
<
T
=
unknown
>
(
timeoutOrOptions
?:
|
number
|
{
expectedTag
?:
string
;
signal
?:
AbortSignal
;
timeoutMs
?:
number
}
,
signal
?:
AbortSignal
,
)
:
Promise
<
StatusOr
<
T
|
null
>
>
Type Parameters
T
=
unknown
Parameters
Optional
timeoutOrOptions
:
number
|
{
expectedTag
?:
string
;
signal
?:
AbortSignal
;
timeoutMs
?:
number
}
Optional
signal
:
AbortSignal
Returns
Promise
<
StatusOr
<
T
|
null
>
>
next
Chunk
nextChunk
(
timeoutMs
?:
number
,
signal
?:
AbortSignal
,
)
:
Promise
<
StatusOr
<
Chunk
|
null
>
>
Parameters
Optional
timeoutMs
:
number
Optional
signal
:
AbortSignal
Returns
Promise
<
StatusOr
<
Chunk
|
null
>
>
next
Fragment
nextFragment
(
timeoutMs
?:
number
,
signal
?:
AbortSignal
,
)
:
Promise
<
StatusOr
<
NodeFragment
|
null
>
>
Parameters
Optional
timeoutMs
:
number
Optional
signal
:
AbortSignal
Returns
Promise
<
StatusOr
<
NodeFragment
|
null
>
>
put
put
(
value
:
unknown
,
options
?:
{
final
?:
boolean
;
mimetype
?:
string
;
seq
?:
number
}
,
)
:
Promise
<
StatusOr
<
number
>
>
Parameters
value
:
unknown
options
:
{
final
?:
boolean
;
mimetype
?:
string
;
seq
?:
number
}
= {}
Returns
Promise
<
StatusOr
<
number
>
>
put
Chunk
putChunk
(
chunk
:
Chunk
|
NodeRef
,
sequence
?:
number
,
final
?:
boolean
,
)
:
Promise
<
StatusOr
<
number
>
>
Parameters
chunk
:
Chunk
|
NodeRef
Optional
sequence
:
number
final
:
boolean
= false
Returns
Promise
<
StatusOr
<
number
>
>
put
Fragment
putFragment
(
fragment
:
NodeFragment
)
:
Promise
<
StatusOr
<
number
>
>
Parameters
fragment
:
NodeFragment
Returns
Promise
<
StatusOr
<
number
>
>
ref
ref
(
options
?:
{
length
?:
number
|
null
;
offset
?:
number
;
storage
?:
"auto"
|
"include"
|
"omit"
;
}
,
)
:
Promise
<
StatusOr
<
NodeRef
>
>
Parameters
options
:
{
length
?:
number
|
null
;
offset
?:
number
;
storage
?:
"auto"
|
"include"
|
"omit"
;
}
= {}
Returns
Promise
<
StatusOr
<
NodeRef
>
>
reset
Reader
resetReader
(
options
?:
ChunkStoreReaderOptions
)
:
Promise
<
Status
>
Parameters
Optional
options
:
ChunkStoreReaderOptions
Returns
Promise
<
Status
>
set
Reader
Options
setReaderOptions
(
options
:
ChunkStoreReaderOptions
)
:
Promise
<
Status
>
Parameters
options
:
ChunkStoreReaderOptions
Returns
Promise
<
Status
>
set
Writer
Options
setWriterOptions
(
options
:
ChunkStoreWriterOptions
)
:
Promise
<
Status
>
Parameters
options
:
ChunkStoreWriterOptions
Returns
Promise
<
Status
>
state
state
()
:
Promise
<
StatusOr
<
{
readerStatus
:
Status
;
writerAbortStatus
:
Status
|
null
;
writerStatus
:
Status
;
}
,
>
,
>
Returns
Promise
<
StatusOr
<
{
readerStatus
:
Status
;
writerAbortStatus
:
Status
|
null
;
writerStatus
:
Status
;
}
,
>
,
>
values
values
<
T
=
unknown
>
(
options
?:
{
signal
?:
AbortSignal
;
timeoutMs
?:
number
}
,
)
:
AsyncGenerator
<
StatusOr
<
T
>
,
void
,
void
>
Type Parameters
T
=
unknown
Parameters
options
:
{
signal
?:
AbortSignal
;
timeoutMs
?:
number
}
= {}
Returns
AsyncGenerator
<
StatusOr
<
T
>
,
void
,
void
>
wait
For
Buffer
To
Drain
waitForBufferToDrain
(
timeoutMs
?:
number
)
:
Promise
<
Status
>
Parameters
Optional
timeoutMs
:
number
Returns
Promise
<
Status
>
Static
create
create
(
id
:
string
,
options
:
AsyncNodeOptions
)
:
Promise
<
StatusOr
<
GraphNode
>
>
Parameters
id
:
string
options
:
AsyncNodeOptions
Returns
Promise
<
StatusOr
<
GraphNode
>
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
[async
Iterator]
abort
With
Status
cancel
cancel
Reader
cancel
Writer
close
consume
finalize
get
Id
get
Reader
Options
get
Reader
Status
get
Writer
Abort
Status
get
Writer
Options
get
Writer
Status
is
Writable
next
next
Chunk
next
Fragment
put
put
Chunk
put
Fragment
ref
reset
Reader
set
Reader
Options
set
Writer
Options
state
values
wait
For
Buffer
To
Drain
create
A11 guides
Python API
C++ internals
A11 TypeScript API - v0.7.26
Loading...
A typed value stream whose reader and writer are C++ AsyncNode objects.