config.dependencies.authoraide_api.preload - Initialization - Author API

Author API Initialization

preload

Controls whether Author Aide API is preloaded when Author API is initialized.

You would want to use this to reduce the initial loading time for Author Aide API. This reduces load time when first opening Author Aide, however, may slow down the Author API initialization process.

ImportantThis will only have an effect if Author Aide is enabled for a given consumer and enable is set to true.

Examples

// Preload Author Aide
var initializationOptions = {
    "config": {
        "dependencies": {
            "authoraide_api": {
                "enable": true,
                "preload": true
            }
        }
    }
};

Values

Attribute path config.dependencies.authoraide_api.preload

Default false

Type boolean

Setting this value to true preloads Author Aide API on Author API initialization, false lazy loads Author Aide when it is first needed.

Was this article helpful?

Did you arrive here by accident? If so, learn more about Learnosity.