Class NostrSub

Hierarchy

Constructors

constructor

Properties

_events _filter _init _opt _socket _sub_id

Accessors

filter ready sub_id

Methods

_get_methods cancel clear emit has on once remove update when_cancel when_ready within

Constructors

constructor

Properties

Readonly Private _events

_events: Map<"cancel" | "event" | "ready", Set<Function>>

Private _filter

_filter: EventFilter

Private _init

_init: boolean

Readonly Private _opt

_opt: SubscribeConfig

Readonly Private _socket

_socket: NostrSocket

Readonly Private _sub_id

_sub_id: string

Accessors

filter

ready

sub_id

Methods

Private _get_methods

  • _get_methods(event): Set<Function>

  • Parameters

    • event: string

    Returns Set<Function>

cancel

clear

  • clear(event): void

  • Parameters

    • event: string

    Returns void

emit

  • emit<K>(event, args): void

  • Type Parameters

    • K extends "cancel" | "event" | "ready"

    Parameters

    Returns void

has

  • has<K>(topic): boolean

  • Type Parameters

    • K extends "cancel" | "event" | "ready"

    Parameters

    • topic: K

    Returns boolean

on

  • on<K>(event, method): void

  • Type Parameters

    • K extends "cancel" | "event" | "ready"

    Parameters

    • event: K
    • method: ((args) => void | Promise<void>)
        • (args): void | Promise<void>

        • Parameters

          Returns void | Promise<void>

    Returns void

once

  • once<K>(event, method): void

  • Type Parameters

    • K extends "cancel" | "event" | "ready"

    Parameters

    • event: K
    • method: ((args) => void | Promise<void>)
        • (args): void | Promise<void>

        • Parameters

          Returns void | Promise<void>

    Returns void

remove

  • remove<K>(event, method): void

  • Type Parameters

    • K extends "cancel" | "event" | "ready"

    Parameters

    • event: string
    • method: ((args) => void | Promise<void>)
        • (args): void | Promise<void>

        • Parameters

          Returns void | Promise<void>

    Returns void

update

when_cancel

  • when_cancel(): Promise<unknown>

  • Returns Promise<unknown>

when_ready

  • when_ready(): Promise<unknown>

  • Returns Promise<unknown>

within

  • within<K>(event, method, timeout): void

  • Type Parameters

    • K extends "cancel" | "event" | "ready"

    Parameters

    • event: K
    • method: ((args) => void | Promise<void>)
        • (args): void | Promise<void>

        • Parameters

          Returns void | Promise<void>

    • timeout: number

    Returns void

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc