NiceRelaySub

import type { NiceRelaySub } from "https://gitlab.com/soapbox-pub/nostr-machina/-/raw/main/mod.ts";

Relay subscription interface. Loop over it to get events.

@example

for await (const event of sub) {
  console.log(event);
}

interface NiceRelaySub <K extends number> {

[[Symbol.asyncIterator]]: () => AsyncGenerator<Event<K>>;

close: () => void;

eoseSignal: AbortSignal;

id: string;

}

§Type Parameters

K extends number

[[Symbol.asyncIterator]]: () => AsyncGenerator<Event<K>>

close: () => void

Close the subscription.

eoseSignal: AbortSignal

Signal that gets aborted when an EOSE message is received for this subscription.

@example

sub.eoseSignal.onabort = () => sub.close();

for await (const event of sub) {
  console.log(event);
}

id: string

ID of the subscription.