Interface InstrumentOptions

The instrument options

interface InstrumentOptions {
    auth?: false | BasicAuthentication;
    mode: "development" | "production";
    namespaceName: string;
    readonly: boolean;
    serverId?: string;
    store: InMemoryStore | RedisStore;
}

Properties

auth? mode namespaceName readonly serverId? store

Properties

Optionalauth

auth?: false | BasicAuthentication

The authentication method

mode

mode: "development" | "production"

Whether to send all events or only aggregated events to the UI, for performance purposes.

namespaceName

namespaceName: string

The name of the admin namespace

Default Value

"/admin"

readonly

readonly: boolean

Whether updates are allowed

Default Value

false

OptionalserverId

serverId?: string

The unique ID of the server

Default Value

require("os").hostname()

store

store: InMemoryStore | RedisStore

The store

Settings

Member Visibility

On This Page

Properties