XYO Platform SDK - v3.10.6
    Preparing search index...

    Interface ModuleConfigFields

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

    Properties

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

    Properties

    allowedQueries?: string[]

    Limit to only these allowed queries

    archivist?: string

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

    labels?: Labels

    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.

    logLevel?: LogLevel
    name?: string

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

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

    paging settings for queries

    retry?: RetryConfig
    security?: ModuleSecurityConfig

    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.

    sign?: boolean

    sign every query

    storeQueries?: boolean

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

    timestamp?: boolean

    add a timestamp payload to every query

    Settings

    Member Visibility

    On This Page

    Properties