@wharfkit/actionstream - v4.0.2
Preparing search index...
ActionStreamClient
Class ActionStreamClient
Index
Constructors
constructor
Properties
on
Catchup
Complete?
on
Connect?
on
Disconnect?
on
Error?
on
Gap?
on
Heartbeat?
on
Overflow?
Accessors
catchup
Complete
connected
head
Seq
lib
Seq
overflow
Count
Methods
[async
Iterator]
close
connect
next
next
With
Timeout
Constructors
constructor
new
ActionStreamClient
(
url
:
string
,
filter
:
ActionStreamFilter
,
options
?:
ActionStreamOptions
,
)
:
ActionStreamClient
Parameters
url
:
string
filter
:
ActionStreamFilter
Optional
options
:
ActionStreamOptions
Returns
ActionStreamClient
Properties
Optional
on
Catchup
Complete
onCatchupComplete
?:
(
state
:
StreamState
)
=>
void
Optional
on
Connect
onConnect
?:
()
=>
void
Optional
on
Disconnect
onDisconnect
?:
()
=>
void
Optional
on
Error
onError
?:
(
code
:
number
,
message
:
string
)
=>
void
Optional
on
Gap
onGap
?:
(
gap
:
StreamGap
)
=>
void
Optional
on
Heartbeat
onHeartbeat
?:
(
state
:
StreamState
)
=>
void
Optional
on
Overflow
onOverflow
?:
(
overflow
:
StreamOverflow
)
=>
void
Accessors
catchup
Complete
get
catchupComplete
()
:
boolean
Returns
boolean
connected
get
connected
()
:
boolean
Returns
boolean
head
Seq
get
headSeq
()
:
UInt64
Returns
UInt64
lib
Seq
get
libSeq
()
:
UInt64
Returns
UInt64
overflow
Count
get
overflowCount
()
:
number
Returns
number
Methods
[async
Iterator]
"[asyncIterator]"
()
:
AsyncIterableIterator
<
StreamAction
>
Returns
AsyncIterableIterator
<
StreamAction
>
close
close
()
:
void
Returns
void
connect
connect
()
:
void
Returns
void
next
next
()
:
Promise
<
StreamAction
>
Returns
Promise
<
StreamAction
>
next
With
Timeout
nextWithTimeout
(
timeoutMs
:
number
)
:
Promise
<
StreamAction
|
null
>
Parameters
timeoutMs
:
number
Returns
Promise
<
StreamAction
|
null
>
Settings
Member Visibility
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Properties
on
Catchup
Complete
on
Connect
on
Disconnect
on
Error
on
Gap
on
Heartbeat
on
Overflow
Accessors
catchup
Complete
connected
head
Seq
lib
Seq
overflow
Count
Methods
[async
Iterator]
close
connect
next
next
With
Timeout
@wharfkit/actionstream - v4.0.2
Loading...