@nostr/tools@2.15.1

latest

nbd-wtf/nostr-tools

Tools for developing Nostr clients.

JSR Score

70%

Published

2 days ago (2.15.1)

@nostr/tools

abstract-relay

AbstractRelay

class AbstractRelay

Constructors

new



AbstractRelay(url: string,
opts: AbstractRelayConstructorOptions,
)

Properties



baseEoseTimeout: number

readonly



connected: boolean



connectionTimeout: number



onclose: (() => void) | null



onnotice: (msg: string) => void



openSubs: Map<string, Subscription>



publishTimeout: number

readonly



url: string

private



_WebSocket: WebSocket

private



_connected: boolean

private



authPromise: Promise<string> | undefined

private



challenge: string | undefined

private



connectionPromise: Promise<void> | undefined

private



connectionTimeoutHandle: ReturnType<setTimeout> | undefined

private



incomingMessageQueue: Queue<string>

private



openCountRequests: Map<string, CountResolver>

private



openEventPublishes: Map<string, EventPublishResolver>

private



queueRunning: boolean

private



serial: number

private



verifyEvent: Nostr["verifyEvent"]

private



ws: WebSocket | undefined

Methods



_onmessage(ev: MessageEvent<any>): void



auth(signAuthEvent: (evt: EventTemplate) => Promise<VerifiedEvent>): Promise<string>



close(): void

private



closeAllSubscriptions(reason: string): void



connect(): Promise<void>



count(filters: Filter[],
params: { id?: string | null;  },
): Promise<number>

private



handleNext(): undefined | false



prepareSubscription(filters: Filter[],
params: Partial<SubscriptionParams> & { label?: string; id?: string;  },
): Subscription



publish(event: Event): Promise<string>

private



runQueue(): Promise<void>



send(message: string): Promise<void>



subscribe(filters: Filter[],
params: Partial<SubscriptionParams> & { label?: string; id?: string;  },
): Subscription

Static Methods



connect(url: string,
opts: AbstractRelayConstructorOptions,
): Promise<AbstractRelay>

Add Package

deno add jsr:@nostr/tools

Import symbol

import { AbstractRelay } from "@nostr/tools/abstract-relay";

Import directly with a jsr specifier

import { AbstractRelay } from "jsr:@nostr/tools/abstract-relay";

Add Package

pnpm i jsr:@nostr/tools

or (using pnpm 10.8 or older)

pnpm dlx jsr add @nostr/tools

Import symbol

import { AbstractRelay } from "@nostr/tools/abstract-relay";

Add Package

yarn add jsr:@nostr/tools

or (using Yarn 4.8 or older)

yarn dlx jsr add @nostr/tools

Import symbol

import { AbstractRelay } from "@nostr/tools/abstract-relay";

Add Package

vlt install jsr:@nostr/tools

Import symbol

import { AbstractRelay } from "@nostr/tools/abstract-relay";

Add Package

npx jsr add @nostr/tools

Import symbol

import { AbstractRelay } from "@nostr/tools/abstract-relay";

Add Package

bunx jsr add @nostr/tools

Import symbol

import { AbstractRelay } from "@nostr/tools/abstract-relay";

@nostr/tools@2.15.1

Constructors

Properties

Methods

Static Methods

New Ticket: Report package