A11 TypeScript API - v0.7.26
A11 guides
Python API
C++ internals
Preparing search index...
NodeBinding
Interface NodeBinding
Worker operations used by the typed node convenience.
interface
NodeBinding
{
id
:
string
;
abortWithStatus
(
status
:
Status
)
:
Promise
<
unknown
>
;
cancel
()
:
Promise
<
unknown
>
;
cancelReader
()
:
Promise
<
unknown
>
;
cancelWriter
()
:
Promise
<
unknown
>
;
close
()
:
Promise
<
unknown
>
;
finalize
(
value
?:
{
chunk
?:
Record
<
string
,
unknown
>
;
close
?:
boolean
;
reference
?:
Record
<
string
,
unknown
>
;
sequence
?:
number
;
wait
?:
boolean
;
}
,
)
:
Promise
<
unknown
>
;
isWritable
()
:
Promise
<
boolean
>
;
nextChunk
(
options
?:
{
signal
?:
AbortSignal
;
timeoutMs
?:
number
}
,
)
:
Promise
<
Record
<
string
,
unknown
>
|
null
>
;
nextFragment
(
options
?:
{
signal
?:
AbortSignal
;
timeoutMs
?:
number
}
,
)
:
Promise
<
Record
<
string
,
unknown
>
|
null
>
;
putChunk
(
chunk
:
Record
<
string
,
unknown
>
,
options
?:
{
final
?:
boolean
;
sequence
?:
number
}
,
)
:
Promise
<
{
sequence
:
number
}
>
;
putFragment
(
fragment
:
Record
<
string
,
unknown
>
,
)
:
Promise
<
{
sequence
:
number
}
>
;
readerOptions
()
:
Promise
<
ChunkStoreReaderOptions
>
;
ready
()
:
Promise
<
unknown
>
;
ref
(
options
?:
{
length
?:
number
|
null
;
offset
?:
number
;
storage
?:
"auto"
|
"include"
|
"omit"
;
}
,
)
:
Promise
<
Record
<
string
,
unknown
>
>
;
resetReader
(
options
?:
ChunkStoreReaderOptions
)
:
Promise
<
unknown
>
;
setReaderOptions
(
options
:
ChunkStoreReaderOptions
)
:
Promise
<
unknown
>
;
setWriterOptions
(
options
:
ChunkStoreWriterOptions
)
:
Promise
<
unknown
>
;
state
()
:
Promise
<
{
readerStatus
:
Status
;
writerAbortStatus
:
Status
|
null
;
writerStatus
:
Status
;
}
,
>
;
waitForBufferToDrain
(
options
?:
{
timeoutMs
?:
number
}
)
:
Promise
<
unknown
>
;
writerOptions
()
:
Promise
<
ChunkStoreWriterOptions
>
;
}
Index
Properties
id
Methods
abort
With
Status
cancel
cancel
Reader
cancel
Writer
close
finalize
is
Writable
next
Chunk
next
Fragment
put
Chunk
put
Fragment
reader
Options
ready
ref
reset
Reader
set
Reader
Options
set
Writer
Options
state
wait
For
Buffer
To
Drain
writer
Options
Properties
Readonly
id
id
:
string
Methods
abort
With
Status
abortWithStatus
(
status
:
Status
)
:
Promise
<
unknown
>
Parameters
status
:
Status
Returns
Promise
<
unknown
>
cancel
cancel
()
:
Promise
<
unknown
>
Returns
Promise
<
unknown
>
cancel
Reader
cancelReader
()
:
Promise
<
unknown
>
Returns
Promise
<
unknown
>
cancel
Writer
cancelWriter
()
:
Promise
<
unknown
>
Returns
Promise
<
unknown
>
close
close
()
:
Promise
<
unknown
>
Returns
Promise
<
unknown
>
finalize
finalize
(
value
?:
{
chunk
?:
Record
<
string
,
unknown
>
;
close
?:
boolean
;
reference
?:
Record
<
string
,
unknown
>
;
sequence
?:
number
;
wait
?:
boolean
;
}
,
)
:
Promise
<
unknown
>
Parameters
Optional
value
:
{
chunk
?:
Record
<
string
,
unknown
>
;
close
?:
boolean
;
reference
?:
Record
<
string
,
unknown
>
;
sequence
?:
number
;
wait
?:
boolean
;
}
Returns
Promise
<
unknown
>
is
Writable
isWritable
()
:
Promise
<
boolean
>
Returns
Promise
<
boolean
>
next
Chunk
nextChunk
(
options
?:
{
signal
?:
AbortSignal
;
timeoutMs
?:
number
}
,
)
:
Promise
<
Record
<
string
,
unknown
>
|
null
>
Parameters
Optional
options
:
{
signal
?:
AbortSignal
;
timeoutMs
?:
number
}
Returns
Promise
<
Record
<
string
,
unknown
>
|
null
>
next
Fragment
nextFragment
(
options
?:
{
signal
?:
AbortSignal
;
timeoutMs
?:
number
}
,
)
:
Promise
<
Record
<
string
,
unknown
>
|
null
>
Parameters
Optional
options
:
{
signal
?:
AbortSignal
;
timeoutMs
?:
number
}
Returns
Promise
<
Record
<
string
,
unknown
>
|
null
>
put
Chunk
putChunk
(
chunk
:
Record
<
string
,
unknown
>
,
options
?:
{
final
?:
boolean
;
sequence
?:
number
}
,
)
:
Promise
<
{
sequence
:
number
}
>
Parameters
chunk
:
Record
<
string
,
unknown
>
Optional
options
:
{
final
?:
boolean
;
sequence
?:
number
}
Returns
Promise
<
{
sequence
:
number
}
>
put
Fragment
putFragment
(
fragment
:
Record
<
string
,
unknown
>
)
:
Promise
<
{
sequence
:
number
}
>
Parameters
fragment
:
Record
<
string
,
unknown
>
Returns
Promise
<
{
sequence
:
number
}
>
reader
Options
readerOptions
()
:
Promise
<
ChunkStoreReaderOptions
>
Returns
Promise
<
ChunkStoreReaderOptions
>
ready
ready
()
:
Promise
<
unknown
>
Returns
Promise
<
unknown
>
ref
ref
(
options
?:
{
length
?:
number
|
null
;
offset
?:
number
;
storage
?:
"auto"
|
"include"
|
"omit"
;
}
,
)
:
Promise
<
Record
<
string
,
unknown
>
>
Parameters
Optional
options
:
{
length
?:
number
|
null
;
offset
?:
number
;
storage
?:
"auto"
|
"include"
|
"omit"
;
}
Returns
Promise
<
Record
<
string
,
unknown
>
>
reset
Reader
resetReader
(
options
?:
ChunkStoreReaderOptions
)
:
Promise
<
unknown
>
Parameters
Optional
options
:
ChunkStoreReaderOptions
Returns
Promise
<
unknown
>
set
Reader
Options
setReaderOptions
(
options
:
ChunkStoreReaderOptions
)
:
Promise
<
unknown
>
Parameters
options
:
ChunkStoreReaderOptions
Returns
Promise
<
unknown
>
set
Writer
Options
setWriterOptions
(
options
:
ChunkStoreWriterOptions
)
:
Promise
<
unknown
>
Parameters
options
:
ChunkStoreWriterOptions
Returns
Promise
<
unknown
>
state
state
()
:
Promise
<
{
readerStatus
:
Status
;
writerAbortStatus
:
Status
|
null
;
writerStatus
:
Status
;
}
,
>
Returns
Promise
<
{
readerStatus
:
Status
;
writerAbortStatus
:
Status
|
null
;
writerStatus
:
Status
;
}
,
>
wait
For
Buffer
To
Drain
waitForBufferToDrain
(
options
?:
{
timeoutMs
?:
number
}
)
:
Promise
<
unknown
>
Parameters
Optional
options
:
{
timeoutMs
?:
number
}
Returns
Promise
<
unknown
>
writer
Options
writerOptions
()
:
Promise
<
ChunkStoreWriterOptions
>
Returns
Promise
<
ChunkStoreWriterOptions
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
id
Methods
abort
With
Status
cancel
cancel
Reader
cancel
Writer
close
finalize
is
Writable
next
Chunk
next
Fragment
put
Chunk
put
Fragment
reader
Options
ready
ref
reset
Reader
set
Reader
Options
set
Writer
Options
state
wait
For
Buffer
To
Drain
writer
Options
A11 guides
Python API
C++ internals
A11 TypeScript API - v0.7.26
Loading...
Worker operations used by the typed node convenience.