Class NostrSocket

Hierarchy

EventEmitter<{
    cancel: [id: string, sub: NostrSub, reason: string];
    close: NostrSocket;
    connected: NostrSocket;
    error: Error;
    event: EventMessage;
    notice: string;
    ready: NostrSocket;
    receipt: ReceiptEnvelope;
    reject: [reason: string, event: string];
    subscribe: [id: string, sub: NostrSub];
}>
- NostrSocket

Constructors

constructor

new NostrSocket(options?): NostrSocket
Parameters
- Optional options: Partial<SocketConfig>
Returns NostrSocket
Overrides EventEmitter <{ 'cancel' : [ id : string, sub : NostrSub, reason : string ] 'connected' : NostrSocket 'close' : NostrSocket 'error' : Error 'event' : EventMessage 'notice' : string 'ready' : NostrSocket 'reject' : [ reason : string, event : string ] 'receipt' : ReceiptEnvelope 'subscribe' : [ id : string, sub : NostrSub ] }>.constructor
- Defined in class/socket.ts:70

Properties

`Private` _address

_address: null | string

`Optional` `Private` _buffer

_buffer?: Timeout

`Readonly` `Private` _events

`Private` _init

_init: boolean

`Readonly` `Private` _opt

_opt: SocketConfig

`Private` _outbox

_outbox: SignedEvent[]

`Private` _socket

_socket: null | WebSocket

`Private` _subs

_subs: Map<string, NostrSub>

log

log: {
debug: ((...s) => null | void);
info: ((...s) => null | void);
} = ...

Type declaration

debug: ((...s) => null | void)
- - (...s): null | void
  - Parameters
    - Rest ...s: unknown[]
    Returns null | void
info: ((...s) => null | void)
- - (...s): null | void
  - Parameters
    - Rest ...s: unknown[]
    Returns null | void

Accessors

address

get address(): string
Returns string
- Defined in class/socket.ts:80

connected

get connected(): boolean
Returns boolean
- Defined in class/socket.ts:91

opt

get opt(): SocketConfig
Returns SocketConfig
- Defined in class/socket.ts:87

ready

get ready(): boolean
Returns boolean
- Defined in class/socket.ts:98

socket

get socket(): WebSocket
Returns WebSocket
- Defined in class/socket.ts:102

subs

get subs(): Map<string, NostrSub>
Returns Map<string, NostrSub>
- Defined in class/socket.ts:109

Methods

`Private` _bounce_handler

_bounce_handler(reason, event): void
Parameters
- reason: string
- event: string
Returns void
- Defined in class/socket.ts:122

`Private` _cancel_handler

_cancel_handler(payload): void
Parameters
- payload: string[]
Returns void
- Defined in class/socket.ts:187

`Private` _eose_handler

_eose_handler(payload): void
Parameters
- payload: string[]
Returns void
- Defined in class/socket.ts:199

`Private` _err_handler

_err_handler(err): void
Parameters
- err: unknown
Returns void
- Defined in class/socket.ts:127

`Private` _event_handler

_event_handler(payload): Promise<void>
Parameters
- payload: string[]
Returns Promise<void>
- Defined in class/socket.ts:135

`Private` _get_methods

_get_methods(event): Set<Function>
Parameters
- event: string
Returns Set<Function>
Inherited from EventEmitter._get_methods
- Defined in class/emitter.ts:16

`Private` _msg_handler

_msg_handler(msg): void | Promise<void>
Parameters
- msg: any
Returns void | Promise<void>
- Defined in class/socket.ts:164

`Private` _notice_handler

_notice_handler(payload): void
Parameters
- payload: string[]
Returns void
- Defined in class/socket.ts:213

`Private` _open_handler

_open_handler(_event): void
Parameters
- _event: unknown
Returns void
- Defined in class/socket.ts:208

`Private` _publish

_publish(events?): Promise<void[]>
Parameters
- events: SignedEvent[] = []
Returns Promise<void[]>
- Defined in class/socket.ts:225

`Private` _receipt_handler

_receipt_handler(payload): void
Parameters
- payload: ReceiptEnvelope
Returns void
- Defined in class/socket.ts:219

`Private` _subscribe

_subscribe(subs?): Promise<void[]>
Parameters
- Optional subs: [string, NostrSub][]
Returns Promise<void[]>
- Defined in class/socket.ts:238

cancel

cancel(sub_id): void
Parameters
- sub_id: string
Returns void
- Defined in class/socket.ts:250

clear

clear(event): void
Parameters
- event: string
Returns void
Inherited from EventEmitter.clear
- Defined in class/emitter.ts:106

close

close(): Promise<NostrSocket>
Returns Promise<NostrSocket>
- Defined in class/socket.ts:298

connect

connect(address?): Promise<NostrSocket>
Parameters
- Optional address: string
Returns Promise<NostrSocket>
- Defined in class/socket.ts:261

emit

emit<K>(event, args): void
Type Parameters
- K extends "cancel" | "connected" | "close" | "error" | "event" | "notice" | "ready" | "reject" | "receipt" | "subscribe"
Parameters
- event: K
- args: {
      cancel: [id: string, sub: NostrSub, reason: string];
      close: NostrSocket;
      connected: NostrSocket;
      error: Error;
      event: EventMessage<any>;
      notice: string;
      ready: NostrSocket;
      receipt: ReceiptEnvelope;
      reject: [reason: string, event: string];
      subscribe: [id: string, sub: NostrSub];
  }[K]
Returns void
Inherited from EventEmitter.emit
- Defined in class/emitter.ts:79

get_sub

get_sub(sub_id): NostrSub
Parameters
- sub_id: string
Returns NostrSub
- Defined in class/socket.ts:308

has

has<K>(topic): boolean
Type Parameters
- K extends "cancel" | "connected" | "close" | "error" | "event" | "notice" | "ready" | "reject" | "receipt" | "subscribe"
Parameters
- topic: K
Returns boolean
Inherited from EventEmitter.has
- Defined in class/emitter.ts:32

on

on<K>(event, method): void
Type Parameters
- K extends "cancel" | "connected" | "close" | "error" | "event" | "notice" | "ready" | "reject" | "receipt" | "subscribe"
Parameters
- event: K
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          cancel: [id: string, sub: NostrSub, reason: string];
          close: NostrSocket;
          connected: NostrSocket;
          error: Error;
          event: EventMessage<any>;
          notice: string;
          ready: NostrSocket;
          receipt: ReceiptEnvelope;
          reject: [reason: string, event: string];
          subscribe: [id: string, sub: NostrSub];
      }[K]
      Returns void | Promise<void>
Returns void
Inherited from EventEmitter.on
- Defined in class/emitter.ts:37

once

once<K>(event, method): void
Type Parameters
- K extends "cancel" | "connected" | "close" | "error" | "event" | "notice" | "ready" | "reject" | "receipt" | "subscribe"
Parameters
- event: K
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          cancel: [id: string, sub: NostrSub, reason: string];
          close: NostrSocket;
          connected: NostrSocket;
          error: Error;
          event: EventMessage<any>;
          notice: string;
          ready: NostrSocket;
          receipt: ReceiptEnvelope;
          reject: [reason: string, event: string];
          subscribe: [id: string, sub: NostrSub];
      }[K]
      Returns void | Promise<void>
Returns void
Inherited from EventEmitter.once
- Defined in class/emitter.ts:47

prefetch

prefetch(filter, close?): Promise<SignedEvent[]>
Parameters
- filter: EventFilter
- close: boolean = false
Returns Promise<SignedEvent[]>
- Defined in class/socket.ts:333

publish

publish(event): void
Parameters
- event: SignedEvent
Returns void
- Defined in class/socket.ts:316

remove

remove<K>(event, method): void
Type Parameters
- K extends "cancel" | "connected" | "close" | "error" | "event" | "notice" | "ready" | "reject" | "receipt" | "subscribe"
Parameters
- event: string
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          cancel: [id: string, sub: NostrSub, reason: string];
          close: NostrSocket;
          connected: NostrSocket;
          error: Error;
          event: EventMessage<any>;
          notice: string;
          ready: NostrSocket;
          receipt: ReceiptEnvelope;
          reject: [reason: string, event: string];
          subscribe: [id: string, sub: NostrSub];
      }[K]
      Returns void | Promise<void>
Returns void
Inherited from EventEmitter.remove
- Defined in class/emitter.ts:98

send

send(event, signer): Promise<unknown>
Parameters
- event: UnsignedEvent
- signer: ((msg) => string | Promise<string>)
  - - (msg): string | Promise<string>
    - Parameters
      msg: string
      Returns string | Promise<string>
Returns Promise<unknown>
- Defined in class/socket.ts:348

sign

sign(event, signer): Promise<{
    content: string;
    created_at: number;
    id: string;
    kind: number;
    pubkey: string;
    sig: string;
    tags: string[][];
}>
Parameters
- event: UnsignedEvent
- signer: ((msg) => string | Promise<string>)
  - - (msg): string | Promise<string>
    - Parameters
      msg: string
      Returns string | Promise<string>
Returns Promise<{
    content: string;
    created_at: number;
    id: string;
    kind: number;
    pubkey: string;
    sig: string;
    tags: string[][];
}>
- Defined in class/socket.ts:362

subscribe(filter, config?): NostrSub
Parameters
- filter: EventFilter
- Optional config: Partial<SubscribeConfig>
Returns NostrSub
- Defined in class/socket.ts:371

when_cancel

when_cancel(sub_id): Promise<unknown>
Parameters
- sub_id: string
Returns Promise<unknown>
- Defined in class/socket.ts:392

when_connected

when_connected(): Promise<unknown>
Returns Promise<unknown>
- Defined in class/socket.ts:407

when_receipt

when_receipt(event_id): Promise<unknown>
Parameters
- event_id: string
Returns Promise<unknown>
- Defined in class/socket.ts:425

when_sub

when_sub(sub_id): Promise<unknown>
Parameters
- sub_id: string
Returns Promise<unknown>
- Defined in class/socket.ts:440

within

within<K>(event, method, timeout): void
Type Parameters
- K extends "cancel" | "connected" | "close" | "error" | "event" | "notice" | "ready" | "reject" | "receipt" | "subscribe"
Parameters
- event: K
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          cancel: [id: string, sub: NostrSub, reason: string];
          close: NostrSocket;
          connected: NostrSocket;
          error: Error;
          event: EventMessage<any>;
          notice: string;
          ready: NostrSocket;
          receipt: ReceiptEnvelope;
          reject: [reason: string, event: string];
          subscribe: [id: string, sub: NostrSub];
      }[K]
      Returns void | Promise<void>
- timeout: number
Returns void
Inherited from EventEmitter.within
- Defined in class/emitter.ts:63

`Static` connect

connect(address, opt?): Promise<NostrSocket>
Parameters
- address: string
- Optional opt: Partial<SocketConfig>
Returns Promise<NostrSocket>
- Defined in class/socket.ts:45

`Static` query

query(address, filter, opt?): Promise<SignedEvent[]>
Parameters
- address: string
- filter: EventFilter
- Optional opt: Partial<SocketConfig>
Returns Promise<SignedEvent[]>
- Defined in class/socket.ts:50

Class NostrSocket

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NostrSocket

Properties

Private _address

Optional Private _buffer

Readonly Private _events

Private _init

Readonly Private _opt

Private _outbox

Private _socket

Private _subs

log

Type declaration

debug: ((...s) => null | void)

Parameters

Returns null | void

info: ((...s) => null | void)

Parameters

Returns null | void

Accessors

address

Returns string

connected

Returns boolean

opt

Returns SocketConfig

ready

Returns boolean

socket

Returns WebSocket

subs

Returns Map<string, NostrSub>

Methods

Private _bounce_handler

Parameters

Returns void

Private _cancel_handler

Parameters

Returns void

Private _eose_handler

Parameters

Returns void

Private _err_handler

Parameters

Returns void

Private _event_handler

Parameters

Returns Promise<void>

Private _get_methods

Parameters

Returns Set<Function>

Private _msg_handler

Parameters

Returns void | Promise<void>

Private _notice_handler

Parameters

Returns void

Private _open_handler

Parameters

Returns void

Private _publish

Parameters

Returns Promise<void[]>

Private _receipt_handler

Parameters

Returns void

Private _subscribe

Parameters

Returns Promise<void[]>

cancel

Parameters

`Private` _address

`Optional` `Private` _buffer

`Readonly` `Private` _events

`Private` _init

`Readonly` `Private` _opt

`Private` _outbox

`Private` _socket

`Private` _subs

`Private` _bounce_handler

`Private` _cancel_handler

`Private` _eose_handler

`Private` _err_handler

`Private` _event_handler

`Private` _get_methods

`Private` _msg_handler

`Private` _notice_handler

`Private` _open_handler

`Private` _publish

`Private` _receipt_handler

`Private` _subscribe

Returns Promise<{
content: string;
created_at: number;
id: string;
kind: number;
pubkey: string;
sig: string;
tags: string[][];
}>