Class EventRepository`Abstract`

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

EventRepository

Index

Constructors

constructor

Methods

count deleteByDeletionRequest destroy find find$ findOne isSearchSupported upsert

Constructors

constructor

new EventRepository(): EventRepository
Returns EventRepository

Methods

count

count(filters, excludedKinds?): Promise<number>
Count distinct events matching any of the filters (NIP-45). Repositories may override this method to opt into COUNT support.
Parameters
- filters: Filter[]
  Query filters
- excludedKinds: number[] = []
  Event kinds that must not contribute to the count
Returns Promise<number>
- Defined in packages/common/src/interfaces/event-repository.interface.ts:53

deleteByDeletionRequest

deleteByDeletionRequest(event): Promise<void>
This method is called when a client requests to delete events.
Parameters
- event: Event
  Deletion request event
Returns Promise<void>
- Defined in packages/common/src/interfaces/event-repository.interface.ts:74

`Abstract`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>
- Defined in packages/common/src/interfaces/event-repository.interface.ts:66

`Abstract`find

find(filter): Event[] | Promise<Event[]> | Observable<Event>
This method is called when a client requests events.
Parameters
- filter: Filter
  Query filter
Returns Event[] | Promise<Event[]> | Observable<Event>
- Defined in packages/common/src/interfaces/event-repository.interface.ts:44

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>
- Defined in packages/common/src/interfaces/event-repository.interface.ts:99

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>
- Defined in packages/common/src/interfaces/event-repository.interface.ts:84

`Abstract`isSearchSupported

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

Returns boolean
- Defined in packages/common/src/interfaces/event-repository.interface.ts:25

`Abstract`upsert

upsert(event): EventRepositoryUpsertResult | 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 EventRepositoryUpsertResult | Promise<EventRepositoryUpsertResult>
- Defined in packages/common/src/interfaces/event-repository.interface.ts:35

Class EventRepository`Abstract`

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EventRepository

Methods

count

Parameters

Returns Promise<number>

deleteByDeletionRequest

Parameters

Returns Promise<void>

`Abstract`destroy

Returns Promise<void>

`Abstract`find

Parameters

Returns Event[] | Promise<Event[]> | Observable<Event>

find$

Parameters

Returns Observable<Event>

findOne

Parameters

Returns Promise<null | Event>

`Abstract`isSearchSupported

Returns boolean

`Abstract`upsert

Parameters

Returns EventRepositoryUpsertResult | Promise<EventRepositoryUpsertResult>

Settings

On This Page

Class EventRepositoryAbstract

Hierarchy

Index

Constructors

Methods

Constructors

constructor

Returns EventRepository

Methods

count

Parameters

Returns Promise<number>

deleteByDeletionRequest

Parameters

Returns Promise<void>

Abstractdestroy

Returns Promise<void>

Abstractfind

Parameters

Returns Event[] | Promise<Event[]> | Observable<Event>

find$

Parameters

Returns Observable<Event>

findOne

Parameters

Returns Promise<null | Event>

AbstractisSearchSupported

Returns boolean

Abstractupsert

Parameters

Returns EventRepositoryUpsertResult | Promise<EventRepositoryUpsertResult>

Settings

On This Page

Class EventRepository`Abstract`

`Abstract`destroy

`Abstract`find

`Abstract`isSearchSupported

`Abstract`upsert