All possible configuration options are defined by the
VendureConfig interface.
ApiOptionsConfiguration for the GraphQL APIs, including hostname, port, CORS settings, middleware etc.
AssetOptionsConfiguration for the handling of Assets.
AuthOptionsConfiguration for authorization.
CatalogOptionsConfiguration for Products and Collections.
CustomFields{}Defines custom fields which can be used to extend the built-in entities.
Defines key-value fields that can be set and read via the getKeyValue/setKeyValue GraphQL APIs
and via the SettingsStoreService. These differ from custom fields in that they are not associated
with a specific entity, but can be scoped globally or to a specific user etc, and defining them does not
require any changes to the database schema.
DataSourceOptionsThe connection options used by TypeORM to connect to the database. See the TypeORM documentation for a full description of all available options.
string | nullnullThe token for the default channel. If not specified, a token will be randomly generated.
LanguageCode<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>.enThe default languageCode of the app.
EntityIdStrategy<any><a href='/reference/typescript-api/configuration/entity-id-strategy#autoincrementidstrategy'>AutoIncrementIdStrategy</a>Defines the strategy used for both storing the primary keys of entities in the database, and the encoding & decoding of those ids when exposing entities via the API. The default uses a simple auto-increment integer strategy.
EntityOptionsImportExportOptionsConfiguration settings for data import and export.
OrderOptionsConfiguration settings governing how orders are handled.
PaymentOptionsConfigures available payment processing methods.
Array<DynamicModule | Type<any>>[]An array of plugins.
PromotionOptionsConfigures the Conditions and Actions available when creating Promotions.
ShippingOptionsConfigures the available checkers and calculators for ShippingMethods.
VendureLogger<a href='/reference/typescript-api/logger/default-logger#defaultlogger'>DefaultLogger</a>Provide a logging service which implements the VendureLogger interface.
Note that the logging of SQL queries is controlled separately by the
dbConnectionOptions.logging property.
TaxOptionsConfigures how taxes are calculated on products.
JobQueueOptionsConfigures how the job queue is persisted and processed.
Configures the scheduler mechanism and tasks.
Configures system options