orpc-client-event-iterator

name	oRPC Client Event Iterator
description	Use event iterators in oRPC clients.
license	MIT
metadata	{"author":"Ali Torki","homepage":"https://github.com/ali-master","version":"1.0.0"}

Event Iterator in oRPC Clients

An Event Iterator in oRPC behaves like an AsyncGenerator.

Basic Usage

const iterator = await client.streaming()

for await (const event of iterator) {
  console.log(event.message)
}

Stopping the Stream Manually

const controller = new AbortController()
const iterator = await client.streaming(undefined, { signal: controller.signal })

setTimeout(async () => {
  controller.abort()
  // or
  await iterator.return()
}, 1000)

for await (const event of iterator) {
  console.log(event.message)
}

Error Handling

Unlike traditional SSE, the Event Iterator does not auto-retry. Use the Client Retry Plugin.

const iterator = await client.streaming()

try {
  for await (const event of iterator) {
    console.log(event.message)
  }
} catch (error) {
  if (error instanceof ORPCError) {
    // Handle the error
  }
}

Using consumeEventIterator

import { consumeEventIterator } from '@orpc/client'

const cancel = consumeEventIterator(client.streaming(), {
  onEvent: (event) => console.log(event.message),
  onError: (error) => console.error(error),
  onSuccess: (value) => console.log(value),
  onFinish: (state) => console.log(state),
})

setTimeout(async () => {
  await cancel()
}, 1000)

This utility accepts both promises and event iterators. Passing a promise lets it infer the correct error type.