Specifies the argument expected to start kassette programmatically with runFromAPI.

interface APIOptions {
    apiConfiguration?: ConfigurationSpec;
    configurationPath?: string;
    fileConfigurationContext?: any;
}

Properties

apiConfiguration?: ConfigurationSpec

kassette configuration passed through the API.

If configurationPath is also specified, both configurations are merged, but apiConfiguration has the least precedence. However, this object is also forwarded to the configuration file's getConfiguration method, as apiConfiguration, so you can apply your own logic to determine what configuration to actually use.

configurationPath?: string

Path to a configuration file, if the configuration should be loaded from a configuration file.

fileConfigurationContext?: any

Specifies the context argument passed to the getConfiguration function defined in the configuration file (only used if configurationPath is specified).