Interface NDKSubscriptionOptions

interface NDKSubscriptionOptions {
    cacheUsage?: NDKSubscriptionCacheUsage;
    closeOnEose?: boolean;
    groupable?: boolean;
    groupableDelay?: number;
    groupableDelayType?: NDKSubscriptionDelayedType;
    pool?: NDKPool;
    skipOptimisticPublishEvent?: boolean;
    skipValidation?: boolean;
    skipVerification?: boolean;
    subId?: string;
}

Properties

cacheUsage? closeOnEose? groupable? groupableDelay? groupableDelayType? pool? skipOptimisticPublishEvent? skipValidation? skipVerification? subId?

Properties

OptionalcacheUsage

cacheUsage?: NDKSubscriptionCacheUsage

OptionalcloseOnEose

closeOnEose?: boolean

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

Default

false

Optionalgroupable

groupable?: boolean

Groupable subscriptions are created with a slight time delayed to allow similar filters to be grouped together.

OptionalgroupableDelay

groupableDelay?: number

The delay to use when grouping subscriptions, specified in milliseconds.

Default

100

Example

const sub1 = ndk.subscribe({ kinds: [1], authors: ["alice"] }, { groupableDelay: 100 });
const sub2 = ndk.subscribe({ kinds: [0], authors: ["alice"] }, { groupableDelay: 1000 });
// sub1 and sub2 will be grouped together and executed 100ms after sub1 was created

OptionalgroupableDelayType

groupableDelayType?: NDKSubscriptionDelayedType

Specifies how this delay should be interpreted. "at-least" means "wait at least this long before sending the subscription" "at-most" means "wait at most this long before sending the subscription"

Default

"at-most"

Example

const sub1 = ndk.subscribe({ kinds: [1], authors: ["alice"] }, { groupableDelay: 100, groupableDelayType: "at-least" });
const sub2 = ndk.subscribe({ kinds: [0], authors: ["alice"] }, { groupableDelay: 1000, groupableDelayType: "at-most" });
// sub1 and sub2 will be grouped together and executed 1000ms after sub1 was created

Optionalpool

pool?: NDKPool

Pool to use

OptionalskipOptimisticPublishEvent

skipOptimisticPublishEvent?: boolean

Skip emitting on events before they are received from a relay. (skip optimistic publish)

Default

false

OptionalskipValidation

skipValidation?: boolean

Skip event validation

Default

false

OptionalskipVerification

skipVerification?: boolean

Skip signature verification

Default

false

OptionalsubId

subId?: string

The subscription ID to use for the subscription.

Settings

Member Visibility

On This Page

Properties