Class NostrStore<T>

Type Parameters

T extends Record<string, any>

Hierarchy

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

Index

Constructors

constructor

new NostrStore<T>(signer, config?): NostrStore<T>
Type Parameters
- T extends Record<string, any>
Parameters
- signer: SignerAPI
- Optional config: Partial<StoreConfig<T>>
Returns NostrStore<T>
Overrides EventEmitter<{ 'close' : NostrStore<T> 'error' : [ error : unknown, data : unknown ] 'fetch' : NostrStore<T> 'ready' : NostrStore<T> 'reject' : [ reason : string, event : SignedEvent ] 'update' : NostrStore<T> }>.constructor
- Defined in class/store.ts:74

Properties

`Optional` `Private` _buffer

_buffer?: Timeout

`Private` _data

_data: null | T

`Readonly` `Private` _events

`Private` _filter

_filter: null | EventFilter

`Private` _init

_init: boolean

`Readonly` `Private` _opt

_opt: StoreConfig<T>

`Private` _prev

_prev: null | T

`Private` _secret

_secret: null | Buff

`Readonly` `Private` _signer

_signer: SignerAPI

`Private` _socket

_socket: null | NostrSocket

`Private` _updated

_updated: null | number

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

`Static` list

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

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/store.ts:94

filter

get filter(): EventFilter
Returns EventFilter
- Defined in class/store.ts:101

hash

get hash(): string
Returns string
- Defined in class/store.ts:108

id

get id(): string
Returns string
- Defined in class/store.ts:113

pubkey

get pubkey(): string
Returns string
- Defined in class/store.ts:120

ready

get ready(): boolean
Returns boolean
- Defined in class/store.ts:124

secret

get secret(): string
Returns string
- Defined in class/store.ts:128

socket

get socket(): NostrSocket
Returns NostrSocket
- Defined in class/store.ts:135

store

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

updated_at

get updated_at(): number
Returns number
- Defined in class/store.ts:146

Methods

[iterator]

[iterator](): IterableIterator<[string, any]>
Returns IterableIterator<[string, any]>
- Defined in class/store.ts:366

`Private` _bounce_handler

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

`Private` _err_handler

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

`Private` _event_filter

_event_filter(event): boolean
Parameters
- event: SignedEvent
Returns boolean
- Defined in class/store.ts:168

`Private` _event_handler

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

`Private` _fetch

_fetch(): Promise<void>
Returns Promise<void>
- Defined in class/store.ts:242

`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/store.ts:231

`Private` _send

_send(data, tags, updated): Promise<NostrStore<T>>
Parameters
- data: unknown
- tags: string[][]
- updated: number
Returns Promise<NostrStore<T>>
- Defined in class/store.ts:248

`Private` _update

_update(data, updated): NostrStore<T>
Parameters
- data: T
- updated: number
Returns NostrStore<T>
- Defined in class/store.ts:278

clear

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

close

close(): Promise<NostrStore<T>>
Returns Promise<NostrStore<T>>
- Defined in class/store.ts:310

connect

connect(address, secret, opt?): Promise<NostrStore<T>>
Parameters
- address: string
- secret: string
- Optional opt: Partial<SocketConfig>
Returns Promise<NostrStore<T>>
- Defined in class/store.ts:298

delete

delete(): void
Returns void
- Defined in class/store.ts:315

emit

emit<K>(event, args): void
Type Parameters
- K extends "close" | "error" | "ready" | "reject" | "fetch" | "update"
Parameters
- event: K
- args: {
      close: NostrStore<T>;
      error: [error: unknown, data: unknown];
      fetch: NostrStore<T>;
      ready: NostrStore<T>;
      reject: [reason: string, event: SignedEvent];
      update: NostrStore<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/store.ts:319

has

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

init

init(address, secret, store, opt?): Promise<NostrStore<T>>
Parameters
- address: string
- secret: string
- store: T
- Optional opt: Partial<SocketConfig>
Returns Promise<NostrStore<T>>
- Defined in class/store.ts:325

on

on<K>(event, method): void
Type Parameters
- K extends "close" | "error" | "ready" | "reject" | "fetch" | "update"
Parameters
- event: K
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          close: NostrStore<T>;
          error: [error: unknown, data: unknown];
          fetch: NostrStore<T>;
          ready: NostrStore<T>;
          reject: [reason: string, event: SignedEvent];
          update: NostrStore<T>;
      }[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 "close" | "error" | "ready" | "reject" | "fetch" | "update"
Parameters
- event: K
- method: ((args) => void | Promise<void>)
  - - (args): void | Promise<void>
    - Parameters
      args: {
          close: NostrStore<T>;
          error: [error: unknown, data: unknown];
          fetch: NostrStore<T>;
          ready: NostrStore<T>;
          reject: [reason: string, event: SignedEvent];
          update: NostrStore<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/store.ts:344

remove

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

toJSON

toJSON(): T
Returns T
- Defined in class/store.ts:353

toString

toString(): string
Returns string
- Defined in class/store.ts:349

update

update(data, updated_at?): NostrStore<T>
Parameters
- data: T
- updated_at: number = ...
Returns NostrStore<T>
- Defined in class/store.ts:357

within

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

Class NostrStore<T>

Type Parameters

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

Parameters

Returns NostrStore<T>

Properties

Optional Private _buffer

Private _data

Readonly Private _events

Private _filter

Private _init

Readonly Private _opt

Private _prev

Private _secret

Readonly Private _signer

Private _socket

Private _updated

log

Type declaration

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

Parameters

Returns null | void

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

Parameters

Returns null | void

Static list

Type declaration

Parameters

Returns Promise<StoreItem[]>

Accessors

data

Returns T

filter

Returns EventFilter

hash

Returns string

id

Returns string

pubkey

Returns string

ready

Returns boolean

secret

Returns string

socket

Returns NostrSocket

store

Returns Map<string, any>

updated_at

Returns number

Methods

[iterator]

Returns IterableIterator<[string, any]>

Private _bounce_handler

Parameters

Returns void

Private _err_handler

Parameters

Returns void

Private _event_filter

Parameters

Returns boolean

Private _event_handler

Parameters

Returns void

Private _fetch

Returns Promise<void>

Private _get_methods

Parameters

Returns Set<Function>

Private _initialize

Parameters

`Optional` `Private` _buffer

`Private` _data

`Readonly` `Private` _events

`Private` _filter

`Private` _init

`Readonly` `Private` _opt

`Private` _prev

`Private` _secret

`Readonly` `Private` _signer

`Private` _socket

`Private` _updated

`Static` list

`Private` _bounce_handler

`Private` _err_handler

`Private` _event_filter

`Private` _event_handler

`Private` _fetch

`Private` _get_methods

`Private` _initialize

`Private` _send

`Private` _update