Interface Config

Nymph PubSub Config

interface Config {
    broadcastCounts: boolean;
    entries: string[];
    logger: ((...args) => void);
    originIsAllowed: ((origin) => boolean);
    relays: string[];
}

Properties

broadcastCounts entries logger originIsAllowed relays

Properties

broadcastCounts

broadcastCounts: boolean

Allow clients to request to be notified when other clients subscribe to the same queries.

entries

entries: string[]

The URLs of the Nymph-PubSub servers to directly publish to. These servers are how this host will enter the PubSub network. If you only have one PubSub server, it needs to be listed here.

logger

logger: ((...args) => void)

Function to log PubSub info/error messages.

Type declaration

    • (...args): void

    • Parameters

      • Rest ...args: any[]

      Returns void

originIsAllowed

originIsAllowed: ((origin) => boolean)

Determine whether a client's origin is allowed to connect.

Type declaration

    • (origin): boolean

    • Parameters

      • origin: string

      Returns boolean

relays

relays: string[]

The URLs of additional Nymph-PubSub servers to relay publishes to. If this host is a PubSub server, these servers are how it will continue into your PubSub network.

Settings

Member Visibility

Theme

On This Page

broadcastCountsentriesloggeroriginIsAllowedrelays