Interface ModuleConfigFields

interface ModuleConfigFields {
    allowedQueries?: string[];
    archivist?: string;
    consoleLogger?: LogLevel;
    labels?: Labels;
    name?: string;
    paging?: Record<string, { size?: number }>;
    retry?: RetryConfig;
    security?: ModuleSecurityConfig;
    sign?: boolean;
    storeQueries?: boolean;
    timestamp?: boolean;
}

Properties

allowedQueries? archivist? consoleLogger? labels? name? paging? retry? security? sign? storeQueries? timestamp?

Properties

Optional ReadonlyallowedQueries

allowedQueries?: string[]

Limit to only these allowed queries

Optional Readonlyarchivist

archivist?: string

Field

The name/address of the Archivist to use for this module

Optional ReadonlyconsoleLogger

consoleLogger?: LogLevel

Optional Readonlylabels

labels?: Labels

Field

The labels used for this module. If a label is specified, then the ModuleFactoryLocator will attempt to find a ModuleFactory with the corresponding labels to construct this module.

Optional Readonlyname

name?: string

Field

Friendly name of module (not collision resistent). Can be used to resolve module when registered/attached to Node.

Optional Readonlypaging

paging?: Record<string, { size?: number }>

Field

paging settings for queries

Optional Readonlyretry

retry?: RetryConfig

Optional Readonlysecurity

security?: ModuleSecurityConfig

Field

The query schemas and allowed/disallowed addresses which are allowed to issue them against the module. If both allowed and disallowed is specified, then disallowed takes priority.

Optional Readonlysign

sign?: boolean

Field

sign every query

Optional ReadonlystoreQueries

storeQueries?: boolean

Field

Store the queries made to the module in an archivist if possible

Optional Readonlytimestamp

timestamp?: boolean

Field

add a timestamp payload to every query

Settings

Member Visibility

On This Page

Properties