Represents a subscription to an NDK event stream.

Emits

event Emitted when an event is received by the subscription.

• ({NDKEvent} event - The event received by the subscription,
• {NDKRelay} relay - The relay that received the event,
• {NDKSubscription} subscription - The subscription that received the event.)

Emits

event:dup Emitted when a duplicate event is received by the subscription.

• {NDKEvent} event - The duplicate event received by the subscription.
• {NDKRelay} relay - The relay that received the event.
• {number} timeSinceFirstSeen - The time elapsed since the first time the event was seen.
• {NDKSubscription} subscription - The subscription that received the event.

Emits

eose - Emitted when all relays have reached the end of the event stream.

• {NDKSubscription} subscription - The subscription that received EOSE.

Emits

close - Emitted when the subscription is closed.

• {NDKSubscription} subscription - The subscription that was closed.

Example

const sub = ndk.subscribe({ kinds: [1] }); // Get all kind:1s
sub.on("event", (event) => console.log(event.content); // Show the content
sub.on("eose", () => console.log("All relays have reached the end of the event stream"));
sub.on("close", () => console.log("Subscription closed"));
setTimeout(() => sub.stop(), 10000); // Stop the subscription after 10 seconds
Copy

Description

Subscriptions are created using NDK.subscribe.

Event validation

By defaults, subscriptions will validate events to comply with the minimal requirement of each known NIP. This can be disabled by setting the skipValidation option to true.

Example

const sub = ndk.subscribe({ kinds: [1] }, { skipValidation: false });
sub.on("event", (event) => console.log(event.content); // Only valid events will be received
Copy