Class Axons

Hierarchy

APIResource
- Axons

Index

Constructors

Properties

Methods

create retrieve list publish subscribeSse

Constructors

constructor

new Axons(client: Runloop): Axons
Parameters
- client: Runloop
Returns Axons
Inherited from APIResource.constructor
- Defined in src/resource.ts:8

Properties

`Protected`_client

_client: Runloop

Methods

create

create(
body?: AxonCreateParams,
options?: RequestOptions<unknown>,
): APIPromise<AxonView>
[Beta] Create a new axon.
Parameters
- Optionalbody: AxonCreateParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<AxonView>
- Defined in src/resources/axons.ts:14
create(options?: RequestOptions<unknown>): APIPromise<AxonView>
[Beta] Create a new axon.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<AxonView>
- Defined in src/resources/axons.ts:15

retrieve

retrieve(id: string, options?: RequestOptions<unknown>): APIPromise<AxonView>
[Beta] Get an axon given ID.
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<AxonView>
- Defined in src/resources/axons.ts:29

list

list(options?: RequestOptions<unknown>): APIPromise<AxonListView>
[Beta] List all active axons.
Parameters
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<AxonListView>
- Defined in src/resources/axons.ts:36

publish

publish(
    id: string,
    body: AxonPublishParams,
    options?: RequestOptions<unknown>,
): APIPromise<PublishResultView>
[Beta] Publish an event to a specified axon.
Parameters
- id: string
- body: AxonPublishParams
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<PublishResultView>
- Defined in src/resources/axons.ts:43

subscribeSse

subscribeSse(
id: string,
options?: RequestOptions<unknown>,
): APIPromise<Stream<AxonEventView>>
[Beta] Subscribe to an axon event stream via server-sent events. On idle timeout (408), reconnects with after_sequence derived from the last received event (internal to withStreamAutoReconnect).
Parameters
- id: string
- Optionaloptions: RequestOptions<unknown>
Returns APIPromise<Stream<AxonEventView>>
- Defined in src/resources/axons.ts:56