VendureConfig
VendureConfig
All possible configuration options are defined by the
VendureConfig interface.
Signature
interface VendureConfig {
apiOptions: ApiOptions;
assetOptions?: AssetOptions;
authOptions: AuthOptions;
catalogOptions?: CatalogOptions;
customFields?: CustomFields;
dbConnectionOptions: ConnectionOptions;
defaultChannelToken?: string | null;
defaultLanguageCode?: LanguageCode;
entityIdStrategy?: EntityIdStrategy<any>;
entityOptions?: EntityOptions;
importExportOptions?: ImportExportOptions;
orderOptions?: OrderOptions;
paymentOptions: PaymentOptions;
plugins?: Array<DynamicModule | Type<any>>;
promotionOptions?: PromotionOptions;
shippingOptions?: ShippingOptions;
logger?: VendureLogger;
taxOptions?: TaxOptions;
jobQueueOptions?: JobQueueOptions;
systemOptions?: SystemOptions;
}
Members
apiOptions
property
type:
ApiOptions
Configuration for the GraphQL APIs, including hostname, port, CORS settings,
middleware etc.
assetOptions
property
type:
AssetOptions
Configuration for the handling of Assets.
authOptions
property
type:
AuthOptions
Configuration for authorization.
catalogOptions
property
type:
CatalogOptions
Configuration for Products and Collections.
customFields
Defines custom fields which can be used to extend the built-in entities.
dbConnectionOptions
property
type:
ConnectionOptions
The connection options used by TypeORM to connect to the database.
See the TypeORM documentation for a
full description of all available options.
defaultChannelToken
property
type:
string | null
default:
null
The token for the default channel. If not specified, a token
will be randomly generated.
defaultLanguageCode
The default languageCode of the app.
entityIdStrategy
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
property
type:
EntityOptions
importExportOptions
property
type:
ImportExportOptions
Configuration settings for data import and export.
orderOptions
property
type:
OrderOptions
Configuration settings governing how orders are handled.
paymentOptions
property
type:
PaymentOptions
Configures available payment processing methods.
plugins
property
type:
Array<DynamicModule | Type<any>>
default:
[]
An array of plugins.
promotionOptions
property
type:
PromotionOptions
Configures the Conditions and Actions available when creating Promotions.
shippingOptions
property
type:
ShippingOptions
Configures the available checkers and calculators for ShippingMethods.
logger
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
property
type:
TaxOptions
Configures how taxes are calculated on products.
jobQueueOptions
property
type:
JobQueueOptions
Configures how the job queue is persisted and processed.
systemOptions
Configures system options