Class NostrRoom<T>

Type Parameters

T extends {}

Hierarchy

EventEmitter<{
    close: NostrRoom<T>;
    error: [error: unknown, data: unknown];
    fetch: NostrRoom<T>;
    msg: EventMessage;
    ready: NostrRoom<T>;
    reject: [reason: string, event: SignedEvent];
    update: NostrRoom<T>;
}>
- NostrRoom

Index

Constructors

constructor

new NostrRoom<T>(signer, options?): NostrRoom<T>
Type Parameters
- T extends {}
Parameters
- signer: SignerAPI
- Optional options: Partial<RoomConfig>
Returns NostrRoom<T>
Overrides EventEmitter <{ 'close' : NostrRoom<T> 'error' : [ error : unknown, data : unknown ] 'fetch' : NostrRoom<T> 'msg' : EventMessage 'ready' : NostrRoom<T> 'reject' : [ reason : string, event : SignedEvent ] 'update' : NostrRoom<T> }>.constructor
- Defined in class/room.ts:40

Properties

`Readonly` `Private` _events

`Private` _init

_init: boolean

`Readonly` `Private` _opt

_opt: RoomConfig

`Readonly` `Private` _socket

_socket: NostrSocket

`Readonly` `Private` _store

_store: NostrStore<T>

`Readonly` `Private` _sub

_sub: NostrChannel

`Static` list

list: ((address, signer, filter?, options?) => Promise<StoreItem[]>) = NostrStore.list

Type declaration

- (address, signer, filter?, options?): Promise<StoreItem[]>
- Fetch a list of recoverable stores from the relay.
  Parameters
  - address: string
  - signer: SignerAPI
  - Optional filter: EventFilter
  - Optional options: Partial<SocketConfig>
  Returns Promise<StoreItem[]>

Accessors

data

get data(): T
Returns T
- Defined in class/room.ts:68

socket

get socket(): NostrSocket
Returns NostrSocket
- Defined in class/room.ts:72

store

get store(): Map<string, any>
Returns Map<string, any>
- Defined in class/room.ts:79

Methods

`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/room.ts:83

`Private` _ready_check

_ready_check(): void
Returns void
- Defined in class/room.ts:89

clear

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

close

close(): Promise<NostrRoom<T>>
Returns Promise<NostrRoom<T>>
- Defined in class/room.ts:96

connect

connect(address, secret): Promise<NostrRoom<T>>
Connect to the room using the specified relay address.
Parameters
- address: string
- secret: string
Returns Promise<NostrRoom<T>>
- Defined in class/room.ts:104

delete

delete(): void
Returns void
- Defined in class/room.ts:114

emit

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

fetch

fetch(): Promise<NostrStore<T>>
Returns Promise<NostrStore<T>>
- Defined in class/room.ts:118

has

has<K>(topic): boolean
Type Parameters
- K extends "close" | "error" | "ready" | "reject" | "msg" | "fetch" | "update"
Parameters
- topic: K
Returns boolean
Inherited from EventEmitter.has
- Defined in class/emitter.ts:32

init

init(address, secret, data): Promise<NostrRoom<T>>
Parameters
- address: string
- secret: string
- data: T
Returns Promise<NostrRoom<T>>
- Defined in class/room.ts:122

on

on<K>(event, method): void
Type Parameters
- K extends "close" | "error" | "ready" | "reject" | "msg" | "fetch" | "update"
Parameters
- event: K
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          close: NostrRoom<T>;
          error: [error: unknown, data: unknown];
          fetch: NostrRoom<T>;
          msg: EventMessage<any>;
          ready: NostrRoom<T>;
          reject: [reason: string, event: SignedEvent];
          update: NostrRoom<T>;
      }[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
Parameters
- topic: string
- fn: ((msg) => void)
  - - (msg): void
    - Parameters
      msg: EventMessage<T>
      Returns void
Returns void
- Defined in class/room.ts:133

once

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

refresh

refresh(): Promise<NostrStore<T>>
Returns Promise<NostrStore<T>>
- Defined in class/room.ts:137

remove

remove<K>(event, method): void
Type Parameters
- K extends "close" | "error" | "ready" | "reject" | "msg" | "fetch" | "update"
Parameters
- event: string
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          close: NostrRoom<T>;
          error: [error: unknown, data: unknown];
          fetch: NostrRoom<T>;
          msg: EventMessage<any>;
          ready: NostrRoom<T>;
          reject: [reason: string, event: SignedEvent];
          update: NostrRoom<T>;
      }[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/room.ts:141

update

update(data, updated?): NostrStore<T>
Parameters
- data: T
- Optional updated: number
Returns NostrStore<T>
- Defined in class/room.ts:145

within

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

Class NostrRoom<T>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns NostrRoom<T>

Properties

Readonly Private _events

Private _init

Readonly Private _opt

Readonly Private _socket

Readonly Private _store

Readonly Private _sub

Static list

Type declaration

Parameters

Returns Promise<StoreItem[]>

Accessors

data

Returns T

socket

Returns NostrSocket

store

Returns Map<string, any>

Methods

Private _get_methods

Parameters

Returns Set<Function>

Private _initialize

Parameters

Returns void

Private _ready_check

Returns void

clear

Parameters

Returns void

close

Returns Promise<NostrRoom<T>>

connect

Parameters

Returns Promise<NostrRoom<T>>

delete

Returns void

emit

Type Parameters

Parameters

Returns void

fetch

Returns Promise<NostrStore<T>>

has

Type Parameters

Parameters

Returns boolean

init

Parameters

Returns Promise<NostrRoom<T>>

on

Type Parameters

Parameters

Parameters

Returns void | Promise<void>

Returns void

on_topic

Type Parameters

Parameters

Parameters

Returns void

Returns void

once

Type Parameters

Parameters

Parameters

Returns void | Promise<void>

`Readonly` `Private` _events

`Private` _init

`Readonly` `Private` _opt

`Readonly` `Private` _socket

`Readonly` `Private` _store

`Readonly` `Private` _sub

`Static` list

`Private` _get_methods

`Private` _initialize

`Private` _ready_check