Class EventRepositorySqlite

EventRepository is an interface for storing and retrieving events. You can implement this interface to create your own event repository based on your favorite database.

Hierarchy (view full)

EventRepository
- EventRepositorySqlite

Index

Constructors

constructor

Methods

destroy find find$ findOne getDatabase getDefaultLimit isSearchSupported setDefaultLimit upsert

Constructors

constructor

new EventRepositorySqlite(db, options?): EventRepositorySqlite
Parameters
- db: Database
- Optionaloptions: EventRepositorySqliteOptions
Returns EventRepositorySqlite
Overrides EventRepository.constructor
- Defined in event-repository-sqlite/src/event-repository-sqlite.ts:64
new EventRepositorySqlite(filename?, options?): EventRepositorySqlite
Parameters
- Optionalfilename: string
- Optionaloptions: EventRepositorySqliteOptions
Returns EventRepositorySqlite
Overrides EventRepository.constructor
- Defined in event-repository-sqlite/src/event-repository-sqlite.ts:68

Methods

destroy

destroy(): Promise<void>
This method is called when the event repository should be closed. You can release resources in this method.

Returns Promise<void>
Overrides EventRepository.destroy
- Defined in event-repository-sqlite/src/event-repository-sqlite.ts:93

find

find(filter): Promise<Event[]>
This method is called when a client requests events.
Parameters
- filter: Filter
  Query filter
Returns Promise<Event[]>
Overrides EventRepository.find
- Defined in event-repository-sqlite/src/event-repository-sqlite.ts:186

find$

find$(filter): Observable<Event>
This method doesn't need to be implemented. It's just a helper method for transforming the find method to an observable.
Parameters
- filter: Filter
  Query filter
Returns Observable<Event>
Inherited from EventRepository.find$
- Defined in common/dist/interfaces/event-repository.interface.d.ts:57

findOne

findOne(filter): Promise<null | Event>
This method doesn't need to be implemented. It's just a helper method for finding one event. And it will call find method internally.
Parameters
- filter: Filter
  Query filter
Returns Promise<null | Event>
Inherited from EventRepository.findOne
- Defined in common/dist/interfaces/event-repository.interface.d.ts:50

getDatabase

getDatabase(): Database
Returns Database
- Defined in event-repository-sqlite/src/event-repository-sqlite.ts:89

getDefaultLimit

getDefaultLimit(): number
Returns number
- Defined in event-repository-sqlite/src/event-repository-sqlite.ts:231

isSearchSupported

isSearchSupported(): boolean
Whether the search feature is supported.

Returns boolean
Overrides EventRepository.isSearchSupported
- Defined in event-repository-sqlite/src/event-repository-sqlite.ts:97

setDefaultLimit

setDefaultLimit(limit): void
Parameters
- limit: number
Returns void
- Defined in event-repository-sqlite/src/event-repository-sqlite.ts:235

upsert

upsert(event): Promise<EventRepositoryUpsertResult>
This method is called when a new event should be stored. You should handle the REGULAR, REPLACEABLE and PARAMETERIZED REPLACEABLE events correctly.

More info: https://github.com/nostr-protocol/nips/blob/master/01.md
Parameters
- event: Event
  Event to store
Returns Promise<EventRepositoryUpsertResult>
Overrides EventRepository.upsert
- Defined in event-repository-sqlite/src/event-repository-sqlite.ts:101

Class EventRepositorySqlite

Hierarchy (view full)

Index

Constructors

Methods

Constructors

constructor

Parameters

Returns EventRepositorySqlite

Parameters

Returns EventRepositorySqlite

Methods

destroy

Returns Promise<void>

find

Parameters

Returns Promise<Event[]>

find$

Parameters

Returns Observable<Event>

findOne

Parameters

Returns Promise<null | Event>

getDatabase

Returns Database

getDefaultLimit

Returns number

isSearchSupported

Returns boolean

setDefaultLimit

Parameters

Returns void

upsert

Parameters

Returns Promise<EventRepositoryUpsertResult>

Settings

On This Page