Search
Preparing search index...
The search index is not available
@dfuse/client
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
DefaultStream
Class DefaultStream
Hierarchy
DefaultStream
Implements
Stream
Index
Constructors
constructor
Properties
id
on
Post
Restart
Accessors
on
Message
Methods
close
current
Active
Marker
join
mark
restart
start
Constructors
constructor
new
Default
Stream
(
id
:
string
, registrationMessage
:
OutboundMessage
, onMessage
:
OnStreamMessage
, streamExists
:
(
id
:
string
)
=>
boolean
, unregisterStream
:
(
id
:
string
)
=>
Promise
<
void
>
, socket
:
Socket
, debug
:
IDebugger
)
:
DefaultStream
Parameters
id:
string
registrationMessage:
OutboundMessage
onMessage:
OnStreamMessage
streamExists:
(
id
:
string
)
=>
boolean
(
id
:
string
)
:
boolean
Parameters
id:
string
Returns
boolean
unregisterStream:
(
id
:
string
)
=>
Promise
<
void
>
(
id
:
string
)
:
Promise
<
void
>
Parameters
id:
string
Returns
Promise
<
void
>
socket:
Socket
debug:
IDebugger
Returns
DefaultStream
Properties
Readonly
id
id
:
string
Optional
on
Post
Restart
on
Post
Restart
:
OnStreamRestart
Accessors
on
Message
get
onMessage
(
)
:
OnStreamMessage
Returns
OnStreamMessage
Methods
close
close
(
options
?:
{
error
?:
Error
}
)
:
Promise
<
void
>
Parameters
Default value
options:
{
error
?:
Error
}
= {}
Optional
error
?:
Error
Returns
Promise
<
void
>
current
Active
Marker
current
Active
Marker
(
)
:
StreamMarker
|
undefined
Returns
StreamMarker
|
undefined
join
join
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
mark
mark
(
marker
:
StreamMarker
)
:
void
Parameters
marker:
StreamMarker
Returns
void
restart
restart
(
marker
?:
StreamMarker
)
:
Promise
<
void
>
Parameters
Optional
marker:
StreamMarker
Returns
Promise
<
void
>
start
start
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Globals
Default
Stream
constructor
id
on
Post
Restart
on
Message
close
current
Active
Marker
join
mark
restart
start
Generated using
TypeDoc