Interface IEventSubscriptions

An event store that can be subscribed to

interface IEventSubscriptions {
    addressable(pointer: AddressPointer): Observable<undefined | Event>;
    event(id: string | EventPointer): Observable<undefined | Event>;
    filters(filters: Filter | Filter[], onlyNew?: boolean): Observable<Event>;
    replaceable(pointer: AddressPointerWithoutD): Observable<undefined | Event>;
    replaceable(
        kind: number,
        pubkey: string,
        identifier?: string,
    ): Observable<undefined | Event>;
    timeline(
        filters: Filter | Filter[],
        onlyNew?: boolean,
    ): Observable<Event[]>;
}

Hierarchy (View Summary)

IEventSubscriptions

Index

Methods

addressable event filters replaceable timeline

Methods

addressable

addressable(pointer: AddressPointer): Observable<undefined | Event>
Subscribe to an addressable event by pointer
Parameters
- pointer: AddressPointer
Returns Observable<undefined | Event>
- Defined in packages/core/src/event-store/interface.ts:105

event

event(id: string | EventPointer): Observable<undefined | Event>
Subscribe to an event by id
Parameters
- id: string | EventPointer
Returns Observable<undefined | Event>
- Defined in packages/core/src/event-store/interface.ts:99

filters

filters(filters: Filter | Filter[], onlyNew?: boolean): Observable<Event>
Subscribe to a batch of events that match the filters
Parameters
- filters: Filter | Filter[]
- OptionalonlyNew: boolean
Returns Observable<Event>
- Defined in packages/core/src/event-store/interface.ts:107

replaceable

replaceable(pointer: AddressPointerWithoutD): Observable<undefined | Event>
Subscribe to a replaceable event by pointer
Parameters
- pointer: AddressPointerWithoutD
Returns Observable<undefined | Event>
- Defined in packages/core/src/event-store/interface.ts:101
replaceable(
    kind: number,
    pubkey: string,
    identifier?: string,
): Observable<undefined | Event>
Subscribe to a replaceable event with legacy arguments
Parameters
- kind: number
- pubkey: string
- Optionalidentifier: string
Returns Observable<undefined | Event>
- Defined in packages/core/src/event-store/interface.ts:103

timeline

timeline(filters: Filter | Filter[], onlyNew?: boolean): Observable<Event[]>
Subscribe to a sorted timeline of events that match the filters
Parameters
- filters: Filter | Filter[]
- OptionalonlyNew: boolean
Returns Observable<Event[]>
- Defined in packages/core/src/event-store/interface.ts:109

Interface IEventSubscriptions

Hierarchy (View Summary)

Index

Methods

Methods

addressable

Parameters

Returns Observable<undefined | Event>

event

Parameters

Returns Observable<undefined | Event>

filters

Parameters

Returns Observable<Event>

replaceable

Parameters

Returns Observable<undefined | Event>

Parameters

Returns Observable<undefined | Event>

timeline

Parameters

Returns Observable<Event[]>

Settings

On This Page