Interface FactoryOptions<PortConfig>

Factory configuration options

interface FactoryOptions<PortConfig> {
    config?: Partial<PortConfig>;
    logger?: LoggerInstance;
    name?: string;
    useEnvironment?: string | boolean;
}

Type Parameters

  • PortConfig

Properties

config?: Partial<PortConfig>

Specific port configuration options

Port and provider logger, to be used internally

name?: string

Provider name, used for human-readable logs and identification

useEnvironment?: string | boolean

Flag indicating that the environment configuration variables should be used, merged with the default values and the configuration passed as argument to the provider.

If a string is passed this will be used as prefix for the environment configuration variables, represented in SCREAMING_SNAKE_CASE, that will parsed to camelCase and merged with the rest of the configuration.