Documentation
    Preparing search index...

    Interface Nip66AggregatorOptions

    Options for createNip66Aggregator.

    const options: Nip66AggregatorOptions = {
      pool: myPoolAdapter,
      bootstrap: ['wss://monitor1.example.com', 'wss://monitor2.example.com'],
      networks: ['clearnet'],
    };
    interface Nip66AggregatorOptions {
        bootstrap: readonly string[];
        networks?: readonly string[];
        pool: Nip66RelayPool;
        relayAttributeGroups?: Readonly<
            Record<string, readonly RelayAttributeMatcher[]>,
        >;
    }
    Index

    Properties

    bootstrap networks? pool relayAttributeGroups?

    Properties

    bootstrap: readonly string[]

    Required non-empty list of monitor relay URLs to subscribe against. No default ships in the package.

    networks?: readonly string[]

    Optional network-type narrowing passed to the filter as #n (e.g. ['clearnet', 'tor']). Omit to receive every network.

    pool: Nip66RelayPool

    A Nip66RelayPool adapter supplied by the consumer.

    relayAttributeGroups?: Readonly<
        Record<string, readonly RelayAttributeMatcher[]>,
    >

    Optional named relay-attribute groups for interpreting ad hoc kind-30166 tags. Omit to use DEFAULT_RELAY_ATTRIBUTE_GROUPS.

    Settings

    Member Visibility

    On This Page

    Properties