Class Axons

constructor

• new Axons(client: Runloop): Runloop.Axons

  Parameters

  • client: Runloop

  Returns Runloop.Axons

events

sql

create

• create(
      body?: Runloop.AxonCreateParams,
      options?: RequestOptions<unknown>,
  ): APIPromise<Runloop.AxonView>

  [Beta] Create a new axon.

  Parameters

  • Optionalbody: Runloop.AxonCreateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Runloop.AxonView>

• create(options?: RequestOptions<unknown>): APIPromise<Runloop.AxonView>

  [Beta] Create a new axon.

  Parameters

  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Runloop.AxonView>

retrieve

• retrieve(
      id: string,
      options?: RequestOptions<unknown>,
  ): APIPromise<Runloop.AxonView>

  [Beta] Get an axon by ID. Deleted axons remain readable and include their deletion time.

  Parameters

  • id: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Runloop.AxonView>

update

• update(
      id: string,
      body?: Runloop.AxonUpdateParams,
      options?: RequestOptions<unknown>,
  ): APIPromise<Runloop.AxonView>

  [Beta] Updates the specified axon fields. Omitted fields are left unchanged. An empty metadata map clears the metadata. Deleted axons remain readable but cannot be updated.

  Parameters

  • id: string
  • Optionalbody: Runloop.AxonUpdateParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Runloop.AxonView>

• update(
      id: string,
      options?: RequestOptions<unknown>,
  ): APIPromise<Runloop.AxonView>

  [Beta] Updates the specified axon fields. Omitted fields are left unchanged. An empty metadata map clears the metadata. Deleted axons remain readable but cannot be updated.

  Parameters

  • id: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Runloop.AxonView>

list

• list(
      query?: Runloop.AxonListParams,
      options?: RequestOptions<unknown>,
  ): PagePromise<Runloop.AxonViewsAxonsCursorIDPage, Runloop.AxonView>

  [Beta] List axons, including deleted axons. Deleted axons include their deletion time.

  Parameters

  • Optionalquery: Runloop.AxonListParams
  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<Runloop.AxonViewsAxonsCursorIDPage, Runloop.AxonView>

• list(
      options?: RequestOptions<unknown>,
  ): PagePromise<Runloop.AxonViewsAxonsCursorIDPage, Runloop.AxonView>

  [Beta] List axons, including deleted axons. Deleted axons include their deletion time.

  Parameters

  • Optionaloptions: RequestOptions<unknown>

  Returns PagePromise<Runloop.AxonViewsAxonsCursorIDPage, Runloop.AxonView>

delete

• delete(id: string, options?: RequestOptions<unknown>): APIPromise<unknown>

  [Beta] Delete an axon's event data. The axon's registry record remains readable.

  Parameters

  • id: string
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<unknown>

publish

• publish(
      id: string,
      body: Runloop.AxonPublishParams,
      options?: RequestOptions<unknown>,
  ): APIPromise<Runloop.PublishResultView>

  [Beta] Publish an event to a specified axon.

  Parameters

  • id: string
  • body: Runloop.AxonPublishParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Runloop.PublishResultView>

subscribeSse

• subscribeSse(
      id: string,
      query?: Runloop.AxonSubscribeSseParams,
      options?: RequestOptions<unknown>,
  ): APIPromise<Stream<Runloop.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
  • Optionalquery: Runloop.AxonSubscribeSseParams
  • Optionaloptions: RequestOptions<unknown>

  Returns APIPromise<Stream<Runloop.AxonEventView>>