Class NostrChannel

Hierarchy

EventEmitter<{
    cancel: NostrChannel;
    close: NostrChannel;
    error: [error: unknown, data: unknown];
    msg: EventMessage;
    ready: NostrChannel;
    reject: [reason: string, event: SignedEvent];
}>
- NostrChannel

Index

Constructors

constructor

new NostrChannel(signer, config?): NostrChannel
Parameters
- signer: SignerAPI
- config: Partial<ChannelConfig> = {}
Returns NostrChannel
Overrides EventEmitter <{ 'cancel' : NostrChannel 'close' : NostrChannel 'error' : [ error : unknown, data : unknown ] 'msg' : EventMessage 'ready' : NostrChannel 'reject' : [ reason : string, event : SignedEvent ] }>.constructor
- Defined in class/channel.ts:55

Properties

`Readonly` `Private` _events

`Private` _filter

_filter: null | EventFilter

`Private` _init

_init: boolean

`Readonly` `Private` _opt

_opt: ChannelConfig

`Private` _secret

_secret: null | Buff

`Readonly` `Private` _signer

_signer: SignerAPI

`Private` _socket

_socket: null | NostrSocket

`Private` _sub

_sub: null | 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/channel.ts:71

filter

get filter(): null | EventFilter
Returns null | EventFilter
- Defined in class/channel.ts:75

id

get id(): string
Returns string
- Defined in class/channel.ts:79

pubkey

get pubkey(): string
Returns string
- Defined in class/channel.ts:86

ready

get ready(): boolean
Returns boolean
- Defined in class/channel.ts:90

secret

get secret(): string
Returns string
- Defined in class/channel.ts:94

socket

get socket(): NostrSocket
Returns NostrSocket
- Defined in class/channel.ts:101

sub

get sub(): NostrSub
Returns NostrSub
- Defined in class/channel.ts:108

Methods

`Private` _bounce_handler

_bounce_handler(reason, event): void
Parameters
- reason: string
- event: SignedEvent
Returns void
- Defined in class/channel.ts:124

`Private` _err_handler

_err_handler(err, data): void
Parameters
- err: unknown
- data: unknown
Returns void
- Defined in class/channel.ts:130

`Private` _event_handler

_event_handler(event): void
Parameters
- event: SignedEvent
Returns void
- Defined in class/channel.ts:136

`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` _initialize

_initialize(secret): void
Parameters
- secret: string
Returns void
- Defined in class/channel.ts:167

cancel

cancel(): NostrChannel
Returns NostrChannel
- Defined in class/channel.ts:189

clear

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

close

close(): Promise<NostrChannel>
Returns Promise<NostrChannel>
- Defined in class/channel.ts:194

connect

connect(address, secret, opt?): Promise<NostrChannel>
Parameters
- address: string
- secret: string
- Optional opt: Partial<SocketConfig>
Returns Promise<NostrChannel>
- Defined in class/channel.ts:199

emit

emit<K>(event, args): void
Type Parameters
- K extends "cancel" | "close" | "error" | "ready" | "reject" | "msg"
Parameters
- event: K
- args: {
      cancel: NostrChannel;
      close: NostrChannel;
      error: [error: unknown, data: unknown];
      msg: EventMessage<any>;
      ready: NostrChannel;
      reject: [reason: string, event: SignedEvent];
  }[K]
Returns void
Inherited from EventEmitter.emit
- Defined in class/emitter.ts:79

has

has<K>(topic): boolean
Type Parameters
- K extends "cancel" | "close" | "error" | "ready" | "reject" | "msg"
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" | "close" | "error" | "ready" | "reject" | "msg"
Parameters
- event: K
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          cancel: NostrChannel;
          close: NostrChannel;
          error: [error: unknown, data: unknown];
          msg: EventMessage<any>;
          ready: NostrChannel;
          reject: [reason: string, event: SignedEvent];
      }[K]
      Returns void | Promise<void>
Returns void
Inherited from EventEmitter.on
- Defined in class/emitter.ts:37

on_topic

on_topic<T>(topic, fn): void
Type Parameters
- T = any
Parameters
- topic: string
- fn: ((msg) => void)
  - - (msg): void
    - Parameters
      msg: EventMessage<T>
      Returns void
Returns void
- Defined in class/channel.ts:210

once

once<K>(event, method): void
Type Parameters
- K extends "cancel" | "close" | "error" | "ready" | "reject" | "msg"
Parameters
- event: K
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          cancel: NostrChannel;
          close: NostrChannel;
          error: [error: unknown, data: unknown];
          msg: EventMessage<any>;
          ready: NostrChannel;
          reject: [reason: string, event: SignedEvent];
      }[K]
      Returns void | Promise<void>
Returns void
Inherited from EventEmitter.once
- Defined in class/emitter.ts:47

refresh

refresh(): void
Returns void
- Defined in class/channel.ts:247

remove

remove<K>(event, method): void
Type Parameters
- K extends "cancel" | "close" | "error" | "ready" | "reject" | "msg"
Parameters
- event: string
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          cancel: NostrChannel;
          close: NostrChannel;
          error: [error: unknown, data: unknown];
          msg: EventMessage<any>;
          ready: NostrChannel;
          reject: [reason: string, event: SignedEvent];
      }[K]
      Returns void | Promise<void>
Returns void
Inherited from EventEmitter.remove
- Defined in class/emitter.ts:98

send

send(subject, body): Promise<NostrChannel>
Parameters
- subject: string
- body: string
Returns Promise<NostrChannel>
- Defined in class/channel.ts:223

within

within<K>(event, method, timeout): void
Type Parameters
- K extends "cancel" | "close" | "error" | "ready" | "reject" | "msg"
Parameters
- event: K
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          cancel: NostrChannel;
          close: NostrChannel;
          error: [error: unknown, data: unknown];
          msg: EventMessage<any>;
          ready: NostrChannel;
          reject: [reason: string, event: SignedEvent];
      }[K]
      Returns void | Promise<void>
- timeout: number
Returns void
Inherited from EventEmitter.within
- Defined in class/emitter.ts:63

Class NostrChannel

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns NostrChannel

Properties

Readonly Private _events

Private _filter

Private _init

Readonly Private _opt

Private _secret

Readonly Private _signer

Private _socket

Private _sub

log

Type declaration

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

Parameters

Returns null | void

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

Parameters

Returns null | void

Accessors

address

Returns string

filter

Returns null | EventFilter

id

Returns string

pubkey

Returns string

ready

Returns boolean

secret

Returns string

socket

Returns NostrSocket

sub

Returns NostrSub

Methods

Private _bounce_handler

Parameters

Returns void

Private _err_handler

Parameters

Returns void

Private _event_handler

Parameters

Returns void

Private _get_methods

Parameters

Returns Set<Function>

Private _initialize

Parameters

Returns void

cancel

Returns NostrChannel

clear

Parameters

Returns void

close

Returns Promise<NostrChannel>

connect

Parameters

Returns Promise<NostrChannel>

emit

Type Parameters

Parameters

Returns void

has

Type Parameters

Parameters

Returns boolean

on

`Readonly` `Private` _events

`Private` _filter

`Private` _init

`Readonly` `Private` _opt

`Private` _secret

`Readonly` `Private` _signer

`Private` _socket

`Private` _sub

`Private` _bounce_handler

`Private` _err_handler

`Private` _event_handler

`Private` _get_methods

`Private` _initialize