Class NoteCollection

General use note store based on kind ranges

Hierarchy (view full)

KeyedReplaceableNoteStore
- NoteCollection

Index

Constructors

constructor

new NoteCollection(): NoteCollection
Returns NoteCollection
Overrides KeyedReplaceableNoteStore.constructor
- Defined in packages/system/src/note-collection.ts:97

Properties

`Private` #bufEmit

#bufEmit: TaggedNostrEvent[] = []

`Private` #events

#events: SortedMap<string, TaggedNostrEvent> = ...

`Private` #keyFn

#keyFn: ((ev) => string)

Type declaration

- (ev): string
- Parameters
  - ev: TaggedNostrEvent
  Returns string

`Private` `Optional` #nextEmit

#nextEmit?: Timeout

`Private` #storeSnapshot

#storeSnapshot: NoteStoreSnapshotData = []

`Static` prefixed

prefixed: string | boolean

Accessors

snapshot

get snapshot(): NoteStoreSnapshotData
Returns NoteStoreSnapshotData
Inherited from KeyedReplaceableNoteStore.snapshot
- Defined in packages/system/src/note-collection.ts:34

Methods

add

add(ev): void
Parameters
- ev: TaggedNostrEvent | TaggedNostrEvent[]
Returns void
Inherited from KeyedReplaceableNoteStore.add
- Defined in packages/system/src/note-collection.ts:67

addListener

addListener<T>(event, fn, context?): this
Type Parameters
- T extends "event"
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]
      Returns void
- Optional context: any
Returns this
Inherited from KeyedReplaceableNoteStore.addListener
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:45

clear

clear(): void
Returns void
Inherited from KeyedReplaceableNoteStore.clear
- Defined in packages/system/src/note-collection.ts:83

emit

emit<T>(event, ...args): boolean
Calls each of the listeners registered for a given event.
Type Parameters
- T extends "event"
Parameters
- event: T
- Rest ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]
Returns boolean
Inherited from KeyedReplaceableNoteStore.emit
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:32

eventNames

eventNames(): "event"[]
Return an array listing the events for which the emitter has registered listeners.

Returns "event"[]
Inherited from KeyedReplaceableNoteStore.eventNames
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:15

listenerCount

listenerCount(event): number
Return the number of listeners listening to a given event.
Parameters
- event: "event"
Returns number
Inherited from KeyedReplaceableNoteStore.listenerCount
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:27

listeners

listeners<T>(event): ((...args) => void)[]
Return the listeners registered for a given event.
Type Parameters
- T extends "event"
Parameters
- event: T
Returns ((...args) => void)[]
Inherited from KeyedReplaceableNoteStore.listeners
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:20

off

off<T>(event, fn?, context?, once?): this
Type Parameters
- T extends "event"
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from KeyedReplaceableNoteStore.off
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:69

on

on<T>(event, fn, context?): this
Add a listener for a given event.
Type Parameters
- T extends "event"
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]
      Returns void
- Optional context: any
Returns this
Inherited from KeyedReplaceableNoteStore.on
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:40

`Protected` onChange

onChange(changes): void
Parameters
- changes: TaggedNostrEvent[]
Returns void
Inherited from KeyedReplaceableNoteStore.onChange
- Defined in packages/system/src/note-collection.ts:42

once

once<T>(event, fn, context?): this
Add a one-time listener for a given event.
Type Parameters
- T extends "event"
Parameters
- event: T
- fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]
      Returns void
- Optional context: any
Returns this
Inherited from KeyedReplaceableNoteStore.once
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:54

removeAllListeners

removeAllListeners(event?): this
Remove all listeners, or those of the specified event.
Parameters
- Optional event: "event"
Returns this
Inherited from KeyedReplaceableNoteStore.removeAllListeners
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:79

removeListener

removeListener<T>(event, fn?, context?, once?): this
Remove the listeners of a given event.
Type Parameters
- T extends "event"
Parameters
- event: T
- Optional fn: ((...args) => void)
  - - (...args): void
    - Parameters
      Rest ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]
      Returns void
- Optional context: any
- Optional once: boolean
Returns this
Inherited from KeyedReplaceableNoteStore.removeListener
- Defined in .yarn/cache/eventemitter3-npm-5.0.1-5e423b7df3-543d6c858a.zip/node_modules/eventemitter3/index.d.ts:63

takeSnapshot

takeSnapshot(): TaggedNostrEvent[]
Returns TaggedNostrEvent[]
Inherited from KeyedReplaceableNoteStore.takeSnapshot
- Defined in packages/system/src/note-collection.ts:88

Class NoteCollection

Hierarchy (view full)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns NoteCollection

Properties

Private #bufEmit

Private #events

Private #keyFn

Type declaration

Parameters

ev: TaggedNostrEvent

Returns string

Private Optional #nextEmit

Private #storeSnapshot

Static prefixed

Accessors

snapshot

Returns NoteStoreSnapshotData

Methods

add

Parameters

ev: TaggedNostrEvent | TaggedNostrEvent[]

Returns void

addListener

Type Parameters

T extends "event"

Parameters

event: T

fn: ((...args) => void)

Parameters

Rest ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]

Returns void

Optional context: any

Returns this

clear

Returns void

emit

Type Parameters

T extends "event"

Parameters

event: T

Rest ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]

Returns boolean

eventNames

Returns "event"[]

listenerCount

Parameters

event: "event"

Returns number

listeners

Type Parameters

T extends "event"

Parameters

event: T

Returns ((...args) => void)[]

off

Type Parameters

T extends "event"

Parameters

event: T

Optional fn: ((...args) => void)

Parameters

Rest ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]

Returns void

Optional context: any

Optional once: boolean

Returns this

on

Type Parameters

T extends "event"

Parameters

event: T

fn: ((...args) => void)

Parameters

`Private` #bufEmit

`Private` #events

`Private` #keyFn

`Private` `Optional` #nextEmit

`Private` #storeSnapshot

`Static` prefixed

`Rest` ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]

`Optional` context: any

`Rest` ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]

`Optional` context: any

`Optional` once: boolean

`Rest` ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]

`Optional` context: any

`Protected` onChange

`Rest` ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]

`Optional` context: any

`Optional` event: "event"

`Optional` fn: ((...args) => void)

`Rest` ...args: ArgumentMap<NosteStoreEvents>[Extract<T, "event">]

`Optional` context: any

`Optional` once: boolean