Interface: SubscriptionOptions

Defined in: src/types/interfaces/event-stream.interface.ts:153

Subscription options for firehose.

Properties

cursor?

readonly optional cursor: number

Defined in: src/types/interfaces/event-stream.interface.ts:169

Cursor for resuming subscription.

Remarks

Sequence number to resume from. If omitted, starts from latest. Use getCurrentCursor() to get last processed sequence.

---

filter?

readonly optional filter: object

Defined in: src/types/interfaces/event-stream.interface.ts:178

Collection filters.

collections?

readonly optional collections: readonly NSID[]

Collections to include (NSIDs).

Example

["pub.chive.eprint.submission", "pub.chive.review.comment"]

Remarks

If provided, only events for these collections are emitted. Reduces network traffic and processing overhead.

---

relay

readonly relay: string

Defined in: src/types/interfaces/event-stream.interface.ts:160

Relay WebSocket URL.

Remarks

URL of the AT Protocol relay (e.g., "wss://bsky.network").