Interface IEventSubscriptions

An event store that can be subscribed to

interface IEventSubscriptions {
    addressable(pointer: AddressPointer): Observable<NostrEvent | undefined>;
    contacts(user: string | ProfilePointer): Observable<ProfilePointer[]>;
    event(
        id: string | AddressPointer | EventPointer | AddressPointerWithoutD,
    ): Observable<NostrEvent | undefined>;
    filters(
        filters: Filter | Filter[],
        onlyNew?: boolean,
    ): Observable<NostrEvent>;
    mailboxes(
        user: string | ProfilePointer,
    ): Observable<{ inboxes: string[]; outboxes: string[] } | undefined>;
    profile(
        user: string | ProfilePointer,
    ): Observable<ProfileContent | undefined>;
    replaceable(
        pointer: AddressPointerWithoutD,
    ): Observable<NostrEvent | undefined>;
    replaceable(
        kind: number,
        pubkey: string,
        identifier?: string,
    ): Observable<NostrEvent | undefined>;
    timeline(
        filters: Filter | Filter[],
        onlyNew?: boolean,
    ): Observable<NostrEvent[]>;
}

Hierarchy (View Summary)

IEventSubscriptions
- IAsyncEventStore
- IEventStore

Implemented by

EventModels

Index

Methods

addressable contacts event filters mailboxes profile replaceable timeline

Methods

addressable

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

contacts

contacts(user: string | ProfilePointer): Observable<ProfilePointer[]>
Subscribe to a users contacts
Parameters
- user: string | ProfilePointer
Returns Observable<ProfilePointer[]>
- Defined in packages/core/src/event-store/interface.ts:127

event

event(
id: string | AddressPointer | EventPointer | AddressPointerWithoutD,
): Observable<NostrEvent | undefined>
Subscribe to an event by id or pointer
Parameters
- id: string | AddressPointer | EventPointer | AddressPointerWithoutD
Returns Observable<NostrEvent | undefined>
- Defined in packages/core/src/event-store/interface.ts:112

filters

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

mailboxes

mailboxes(
user: string | ProfilePointer,
): Observable<{ inboxes: string[]; outboxes: string[] } | undefined>
Subscribe to a users mailboxes
Parameters
- user: string | ProfilePointer
Returns Observable<{ inboxes: string[]; outboxes: string[] } | undefined>
- Defined in packages/core/src/event-store/interface.ts:129

profile

profile(user: string | ProfilePointer): Observable<ProfileContent | undefined>
Subscribe to a users profile
Parameters
- user: string | ProfilePointer
Returns Observable<ProfileContent | undefined>
- Defined in packages/core/src/event-store/interface.ts:125

replaceable

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

timeline

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