Search
Preparing search index...
The search index is not available
@dfuse/client
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Globals
DefaultGraphqlStream
Class DefaultGraphqlStream<T>
Type parameters
T =
unknown
Hierarchy
DefaultGraphqlStream
Implements
Stream
Index
Constructors
constructor
Properties
id
on
Post
Restart
Accessors
is
Active
on
Message
Methods
close
current
Active
Marker
join
mark
on
Unregister
restart
start
Constructors
constructor
new
Default
Graphql
Stream
(
id
:
string
, registrationDocument
:
GraphqlDocument
, registrationVariables
:
GraphqlVariables
, onMessage
:
OnGraphqlStreamMessage
<
T
>
, streamExists
:
(
id
:
string
)
=>
boolean
, unregisterStream
:
(
id
:
string
)
=>
Promise
<
void
>
, socket
:
Socket
, debug
:
IDebugger
)
:
DefaultGraphqlStream
Parameters
id:
string
registrationDocument:
GraphqlDocument
registrationVariables:
GraphqlVariables
onMessage:
OnGraphqlStreamMessage
<
T
>
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
DefaultGraphqlStream
Properties
Readonly
id
id
:
string
Optional
on
Post
Restart
on
Post
Restart
:
OnGraphqlStreamRestart
Accessors
is
Active
get
isActive
(
)
:
boolean
set
isActive
(
value
:
boolean
)
:
void
Returns
boolean
Parameters
value:
boolean
Returns
void
on
Message
get
onMessage
(
)
:
OnGraphqlStreamMessage
<
T
>
Returns
OnGraphqlStreamMessage
<
T
>
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
(
)
:
undefined
|
StreamMarker
Returns
undefined
|
StreamMarker
join
join
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
mark
mark
(
marker
:
StreamMarker
)
:
void
Parameters
marker:
StreamMarker
Returns
void
on
Unregister
on
Unregister
(
unregisterError
?:
Error
)
:
void
Parameters
Optional
unregisterError:
Error
Returns
void
restart
restart
(
marker
?:
StreamMarker
)
:
Promise
<
void
>
Parameters
Optional
marker:
StreamMarker
Returns
Promise
<
void
>
start
start
(
)
:
Promise
<
void
>
Returns
Promise
<
void
>
Globals
Default
Graphql
Stream
constructor
id
on
Post
Restart
is
Active
on
Message
close
current
Active
Marker
join
mark
on
Unregister
restart
start
Generated using
TypeDoc