@honua/sdk-js
Preparing search index...
realtime
RealtimeFeatureStore
Interface RealtimeFeatureStore<TFeature>
interface
RealtimeFeatureStore
<
TFeature
=
unknown
>
{
state
:
RealtimeFeatureState
<
TFeature
>
;
apply
(
event
:
RealtimeFeatureEvent
<
TFeature
>
,
)
:
RealtimeFeatureState
<
TFeature
>
;
checkStale
(
options
:
RealtimeStalenessOptions
,
)
:
RealtimeFeatureState
<
TFeature
>
;
close
()
:
void
;
connect
(
transport
:
RealtimeFeatureTransport
<
TFeature
>
,
request
:
RealtimeSubscriptionRequest
,
)
:
RealtimeSubscriptionHandle
;
subscribe
(
listener
:
RealtimeStateListener
<
TFeature
>
,
options
?:
{
fireImmediately
?:
boolean
}
,
)
:
()
=>
void
;
}
Type Parameters
TFeature
=
unknown
Index
Properties
state
Methods
apply
check
Stale
close
connect
subscribe
Properties
Readonly
state
state
:
RealtimeFeatureState
<
TFeature
>
Methods
apply
apply
(
event
:
RealtimeFeatureEvent
<
TFeature
>
)
:
RealtimeFeatureState
<
TFeature
>
Parameters
event
:
RealtimeFeatureEvent
<
TFeature
>
Returns
RealtimeFeatureState
<
TFeature
>
check
Stale
checkStale
(
options
:
RealtimeStalenessOptions
)
:
RealtimeFeatureState
<
TFeature
>
Parameters
options
:
RealtimeStalenessOptions
Returns
RealtimeFeatureState
<
TFeature
>
close
close
()
:
void
Returns
void
connect
connect
(
transport
:
RealtimeFeatureTransport
<
TFeature
>
,
request
:
RealtimeSubscriptionRequest
,
)
:
RealtimeSubscriptionHandle
Parameters
transport
:
RealtimeFeatureTransport
<
TFeature
>
request
:
RealtimeSubscriptionRequest
Returns
RealtimeSubscriptionHandle
subscribe
subscribe
(
listener
:
RealtimeStateListener
<
TFeature
>
,
options
?:
{
fireImmediately
?:
boolean
}
,
)
:
()
=>
void
Parameters
listener
:
RealtimeStateListener
<
TFeature
>
Optional
options
:
{
fireImmediately
?:
boolean
}
Returns
()
=>
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
state
Methods
apply
check
Stale
close
connect
subscribe
@honua/sdk-js
Loading...