VendureConfig
All possible configuration options are defined by the
VendureConfig interface.
apiOptions
ApiOptionsConfiguration for the GraphQL APIs, including hostname, port, CORS settings, middleware etc.
assetOptions
AssetOptionsConfiguration for the handling of Assets.
authOptions
AuthOptionsConfiguration for authorization.
catalogOptions
CatalogOptionsConfiguration for Products and Collections.
customFields
CustomFields{}Defines custom fields which can be used to extend the built-in entities.
settingsStoreFields
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.
dbConnectionOptions
DataSourceOptionsThe connection options used by TypeORM to connect to the database. See the TypeORM documentation for a full description of all available options.
defaultChannelToken
string | nullnullThe token for the default channel. If not specified, a token will be randomly generated.
defaultLanguageCode
LanguageCode<a href='/reference/typescript-api/common/language-code#languagecode'>LanguageCode</a>.enThe default languageCode of the app.
entityIdStrategy
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.
entityOptions
EntityOptionsimportExportOptions
ImportExportOptionsConfiguration settings for data import and export.
orderOptions
OrderOptionsConfiguration settings governing how orders are handled.
paymentOptions
PaymentOptionsConfigures available payment processing methods.
plugins
Array<DynamicModule | Type<any>>[]An array of plugins.
promotionOptions
PromotionOptionsConfigures the Conditions and Actions available when creating Promotions.
shippingOptions
ShippingOptionsConfigures the available checkers and calculators for ShippingMethods.
logger
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.
taxOptions
TaxOptionsConfigures how taxes are calculated on products.
jobQueueOptions
JobQueueOptionsConfigures how the job queue is persisted and processed.
schedulerOptions
Configures the scheduler mechanism and tasks.
systemOptions
Configures system options