Class OcelloidsAgentApi<T>

Exposes the Ocelloids Agent API.

Type Parameters

Implements

Index

Constructors

constructor

Methods

allSubscriptions createSubscription deleteSubscription getSubscription health networks query stream subscribe

Constructors

constructor

new OcelloidsAgentApi<T>(
    config: Required<OcelloidsClientConfig>,
    agentId: string,
    clientApi: OcelloidsClientApi,
): OcelloidsAgentApi<T>
Type Parameters
- T
Parameters
- config: Required<OcelloidsClientConfig>
- agentId: string
- clientApi: OcelloidsClientApi
Returns OcelloidsAgentApi<T>
- Defined in client/src/client.ts:185

Methods

allSubscriptions

allSubscriptions(options?: RequestOptions): Promise<Subscription<T>[]>
Lists all subscriptions.
Parameters
- Optionaloptions: RequestOptions
  The ky request options (fetch compatible)
Returns Promise<Subscription<T>[]>
A promise that resolves with an array of subscriptions.
Implementation of SubscribableApi.allSubscriptions
- Defined in client/src/client.ts:306

createSubscription

createSubscription(
subscription: Omit<Subscription<T>, "agent">,
options?: RequestOptions,
): Promise<unknown>
Creates a subscription.
Parameters
- subscription: Omit<Subscription<T>, "agent">
  The subscription to create.
- Optionaloptions: RequestOptions
  The ky request options (fetch compatible)
Returns Promise<unknown>
A promise that resolves when the subscription is created.
Implementation of SubscribableApi.createSubscription
- Defined in client/src/client.ts:263

deleteSubscription

deleteSubscription(id: string, options?: RequestOptions): Promise<unknown>
Deletes a subscription.
Parameters
- id: string
  The subscription ID.
- Optionaloptions: RequestOptions
  The ky request options (fetch compatible)
Returns Promise<unknown>
Implementation of SubscribableApi.deleteSubscription
- Defined in client/src/client.ts:280

getSubscription

getSubscription(id: string, options?: RequestOptions): Promise<Subscription<T>>
Gets a subscription by its ID.
Parameters
- id: string
  The subscription ID.
- Optionaloptions: RequestOptions
  The ky request options (fetch compatible)
Returns Promise<Subscription<T>>
A promise that resolves with the subscription or rejects if not found.
Implementation of SubscribableApi.getSubscription
- Defined in client/src/client.ts:295

health

health(options?: RequestOptions): Promise<HealthResponse>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<HealthResponse>
Implementation of OcelloidsClientApi.health
- Defined in client/src/client.ts:196

networks

networks(options?: RequestOptions): Promise<Record<string, string[]>>
Parameters
- Optionaloptions: RequestOptions
Returns Promise<Record<string, string[]>>
Implementation of OcelloidsClientApi.networks
- Defined in client/src/client.ts:192

query

query<P = AnyQueryArgs, R = AnyQueryResultItem>(
    args: P,
    pagination?: QueryPagination,
    options?: RequestOptions,
): Promise<QueryResult<R>>
Executes a query on the specified agent.
Type Parameters
- P = AnyQueryArgs
- R = AnyQueryResultItem
Parameters
- args: P
  The query arguments.
- Optionalpagination: QueryPagination
  The pagination configuration.
- Optionaloptions: RequestOptions
  The ky request options (fetch compatible).
Returns Promise<QueryResult<R>>
A promise that resolves to the results of the query.
Implementation of QueryableApi.query
- Defined in client/src/client.ts:240

stream

stream(opts: SseOptions, handler: SseHandler): Promise<EventSource>
Parameters
- opts: SseOptions
- handler: SseHandler
Returns Promise<EventSource>
Implementation of StreamableApi.stream
- Defined in client/src/client.ts:200

subscribe<P = AnyJson>(
    subscription: string | T,
    handlers: WebSocketHandlers<P>,
    onDemandHandlers?: OnDemandSubscriptionHandlers<T>,
): Promise<WebSocket>
Creates an on-demand subscription or connects to an existing one.
Type Parameters
- P = AnyJson
Parameters
- subscription: string | T
  The subscription id or the subscription inputs.
- handlers: WebSocketHandlers<P>
  The WebSocket event handlers.
- OptionalonDemandHandlers: OnDemandSubscriptionHandlers<T>
  The on-demand subscription handlers.
Returns Promise<WebSocket>
A promise that resolves with the WebSocket instance.
Implementation of SubscribableApi.subscribe
- Defined in client/src/client.ts:321

Class OcelloidsAgentApi<T>

Type Parameters

Implements

Index

Constructors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns OcelloidsAgentApi<T>

Methods

allSubscriptions

Parameters

Returns Promise<Subscription<T>[]>

createSubscription

Parameters

Returns Promise<unknown>

deleteSubscription

Parameters

Returns Promise<unknown>

getSubscription

Parameters

Returns Promise<Subscription<T>>

health

Parameters

Returns Promise<HealthResponse>

networks

Parameters

Returns Promise<Record<string, string[]>>

query

Type Parameters

Parameters

Returns Promise<QueryResult<R>>

stream

Parameters

Returns Promise<EventSource>

subscribe

Type Parameters

Parameters

Returns Promise<WebSocket>

Settings

On This Page