@sodazone/ocelloids-client - v2.5.2
Preparing search index...
client
SubscribableApi
Interface SubscribableApi<T, P>
Subscribable Agent API.
interface
SubscribableApi
<
T
=
AnySubscriptionInputs
,
P
=
AnyJson
>
{
allSubscriptions
(
options
?:
Options
)
:
Promise
<
Subscription
<
T
>
[]
>
;
createSubscription
(
subscription
:
Omit
<
Subscription
<
T
>
,
"agent"
>
,
options
?:
Options
,
)
:
Promise
<
unknown
>
;
deleteSubscription
(
id
:
string
,
options
?:
Options
)
:
Promise
<
unknown
>
;
getSubscription
(
id
:
string
,
options
?:
Options
)
:
Promise
<
Subscription
<
T
>
>
;
subscribe
(
subscription
:
string
|
T
,
handlers
:
WebSocketHandlers
<
P
>
,
onDemandHandlers
?:
OnDemandSubscriptionHandlers
<
T
>
,
)
:
Promise
<
WebSocket
>
;
}
Type Parameters
T
=
AnySubscriptionInputs
P
=
AnyJson
Implemented by
OcelloidsAgentApi
Index
Methods
all
Subscriptions
create
Subscription
delete
Subscription
get
Subscription
subscribe
Methods
all
Subscriptions
allSubscriptions
(
options
?:
Options
)
:
Promise
<
Subscription
<
T
>
[]
>
Parameters
Optional
options
:
Options
Returns
Promise
<
Subscription
<
T
>
[]
>
create
Subscription
createSubscription
(
subscription
:
Omit
<
Subscription
<
T
>
,
"agent"
>
,
options
?:
Options
,
)
:
Promise
<
unknown
>
Parameters
subscription
:
Omit
<
Subscription
<
T
>
,
"agent"
>
Optional
options
:
Options
Returns
Promise
<
unknown
>
delete
Subscription
deleteSubscription
(
id
:
string
,
options
?:
Options
)
:
Promise
<
unknown
>
Parameters
id
:
string
Optional
options
:
Options
Returns
Promise
<
unknown
>
get
Subscription
getSubscription
(
id
:
string
,
options
?:
Options
)
:
Promise
<
Subscription
<
T
>
>
Parameters
id
:
string
Optional
options
:
Options
Returns
Promise
<
Subscription
<
T
>
>
subscribe
subscribe
(
subscription
:
string
|
T
,
handlers
:
WebSocketHandlers
<
P
>
,
onDemandHandlers
?:
OnDemandSubscriptionHandlers
<
T
>
,
)
:
Promise
<
WebSocket
>
Parameters
subscription
:
string
|
T
handlers
:
WebSocketHandlers
<
P
>
Optional
onDemandHandlers
:
OnDemandSubscriptionHandlers
<
T
>
Returns
Promise
<
WebSocket
>
Settings
Member Visibility
Protected
Inherited
Theme
OS
Light
Dark
On This Page
Methods
all
Subscriptions
create
Subscription
delete
Subscription
get
Subscription
subscribe
@sodazone/ocelloids-client - v2.5.2
Loading...
Subscribable Agent API.