Skip to content

Latest commit

 

History

History
139 lines (70 loc) · 2.02 KB

SubscriptionStateManager.md

File metadata and controls

139 lines (70 loc) · 2.02 KB

nostr-websocket-utils v0.3.0


nostr-websocket-utils / SubscriptionStateManager

Interface: SubscriptionStateManager

Subscription state manager interface

Methods

registerSubscription()

registerSubscription(subscriptionId, filter): void

Registers a new subscription

Parameters

subscriptionId

string

Subscription ID

filter

Record<string, unknown>

Subscription filter

Returns

void

Defined in

nips/nip-15.ts:33


markComplete()

markComplete(subscriptionId): void

Marks a subscription as complete (EOSE sent)

Parameters

subscriptionId

string

Subscription ID

Returns

void

Defined in

nips/nip-15.ts:42


isComplete()

isComplete(subscriptionId): boolean

Checks if a subscription is complete

Parameters

subscriptionId

string

Subscription ID

Returns

boolean

True if EOSE has been sent

Defined in

nips/nip-15.ts:49


getFilter()

getFilter(subscriptionId): undefined | Record<string, unknown>

Gets subscription filter

Parameters

subscriptionId

string

Subscription ID

Returns

undefined | Record<string, unknown>

Subscription filter

Defined in

nips/nip-15.ts:56


removeSubscription()

removeSubscription(subscriptionId): void

Removes a subscription

Parameters

subscriptionId

string

Subscription ID

Returns

void

Defined in

nips/nip-15.ts:62