Interface NostrPoolRead

Generic interface for a readable nostr pool

interface NostrPoolRead {
    request(
        relays: string[],
        filters: Filter | Filter[],
    ): Promise<NostrEvent[]>;
    subscription(
        relays: string[],
        filters: Filter | Filter[],
    ): Subscribable<NostrEvent[]>;
}

Hierarchy (View Summary)

NostrPoolRead
- NostrPool

Index

Client - Nostr

request subscription

Client - Nostr

request

request(relays: string[], filters: Filter | Filter[]): Promise<NostrEvent[]>
Make a single request to the given relays with filters
Parameters
- relays: string[]
- filters: Filter | Filter[]
Returns Promise<NostrEvent[]>
- Defined in ../home/robert/Projects/marmot-ts/src/client/nostr-interface.ts:40

subscription

subscription(
relays: string[],
filters: Filter | Filter[],
): Subscribable<NostrEvent[]>
Open a subscription to the given relays and filters
Parameters
- relays: string[]
- filters: Filter | Filter[]
Returns Subscribable<NostrEvent[]>
- Defined in ../home/robert/Projects/marmot-ts/src/client/nostr-interface.ts:42

Interface NostrPoolRead

Hierarchy (View Summary)

Index

Client - Nostr

Client - Nostr

request

Parameters

Returns Promise<NostrEvent[]>

subscription

Parameters

Returns Subscribable<NostrEvent[]>

Settings

On This Page