Class NDKSubscription

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

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

Hierarchy

Constructors

constructor

Properties

closeOnEose debug eosesSeen eventFirstSeen filters internalId ndk opts pool relayFilters? relaySet? skipOptimisticPublishEvent skipValidation skipVerification subId?

Accessors

filter groupableDelay groupableDelayType

Methods

closedReceived eoseReceived eventReceived hasAuthorsFilter isGroupable relaysMissingEose start stop

Constructors

constructor

Properties

closeOnEose

closeOnEose: boolean

Whether the subscription should close when all relays have reached the end of the event stream.

debug

debug: Debugger

eosesSeen

eosesSeen: Set<NDKRelay> = ...

Relays that have sent an EOSE.

eventFirstSeen

eventFirstSeen: Map<string, number> = ...

Events that have been seen by the subscription, with the time they were first seen.

Readonlyfilters

filters: NDKFilter<NDKKind>[]

internalId

internalId: string

ndk

ndk: default

Readonlyopts

opts: NDKSubscriptionOptions

Readonlypool

pool: NDKPool

OptionalrelayFilters

relayFilters?: Map<string, NDKFilter<NDKKind>[]>

Tracks the filters as they are executed on each relay

OptionalrelaySet

relaySet?: NDKRelaySet

skipOptimisticPublishEvent

skipOptimisticPublishEvent: boolean = false

ReadonlyskipValidation

skipValidation: boolean = false

ReadonlyskipVerification

skipVerification: boolean = false

Optional ReadonlysubId

subId?: string

Accessors

filter

groupableDelay

groupableDelayType

Methods

closedReceived

eoseReceived

eventReceived

  • eventReceived(event: NDKEvent | NostrEvent, relay: undefined | NDKRelay, fromCache?: boolean, optimisticPublish?: boolean): void

  • Called when an event is received from a relay or the cache

    Parameters

    • event: NDKEvent | NostrEvent
    • relay: undefined | NDKRelay
    • fromCache: boolean = false

      Whether the event was received from the cache

    • optimisticPublish: boolean = false

      Whether this event is coming from an optimistic publish

    Returns void

hasAuthorsFilter

isGroupable

relaysMissingEose

start

  • start(): Promise<void>

  • Start the subscription. This is the main method that should be called after creating a subscription.

    Returns Promise<void>

stop

Settings

Member Visibility

On This Page

Event validation
Constructors
Properties
Accessors
Methods