Bootstrap

import { bootstrap } from '@vendure/core';import { config } from './vendure-config';import { MyPlugin } from './plugins/my-plugin';bootstrap(config, {  // Let's say that `MyPlugin` is not yet compatible with the current version of Vendure  // but we know that it will still work as expected, and we are not able to publish  // a new version of the plugin right now.  ignoreCompatibilityErrorsForPlugins: [MyPlugin],});

Signature

interface BootstrapOptions {    nestApplicationOptions?: NestApplicationOptions;    ignoreCompatibilityErrorsForPlugins?: Array<DynamicModule | Type<any>>;    onBeforeAppListen?: (app: INestApplication) => void | Promise<void>;}

nestApplicationOptions

propertyNestApplicationOptions

These options get passed directly to the NestFactory.create() method.

ignoreCompatibilityErrorsForPlugins

propertyArray<DynamicModule | Type<any>>v3.1.0

Default:[]

By default, if a plugin specifies a compatibility range which does not include the current Vendure version, the bootstrap process will fail. This option allows you to ignore compatibility errors for specific plugins.

This setting should be used with caution, only if you are sure that the plugin will still work as expected with the current version of Vendure.

Example

import { bootstrap } from '@vendure/core';import { config } from './vendure-config';import { MyPlugin } from './plugins/my-plugin';bootstrap(config, { ignoreCompatibilityErrorsForPlugins: [MyPlugin],});

onBeforeAppListen

property(app: INestApplication) => void | Promise<void>v3.6.0

Default:undefined

A function which is called before the app starts listening. This can be used to perform any final configuration of the Nest application. E.g., to set up OpenAPI specification with Swagger.

Example

import { bootstrap } from '@vendure/core';import { config } from './vendure-config';import { SwaggerModule, DocumentBuilder } from '@nestjs/swagger';bootstrap(config, { onBeforeAppListen: async (app) => {   const config = new DocumentBuilder()     .setTitle('Cats example')     .setDescription('The cats API description')     .setVersion('1.0')     .addTag('cats')     .build();   const documentFactory = () => SwaggerModule.createDocument(app, config);   SwaggerModule.setup('api', app, documentFactory); }});

import { bootstrap } from '@vendure/core';import { config } from './vendure-config';bootstrap(config, {  nestApplicationOptions: { // [!code highlight]    snapshot: true, // [!code highlight]  } // [!code highlight]}).catch(err => {  console.log(err);  process.exit(1);});

bootstrap

Passing additional options

Bootstrap

bootstrap

Passing additional options

userConfig

options

BootstrapOptions

nestApplicationOptions

ignoreCompatibilityErrorsForPlugins

onBeforeAppListen

Ignoring compatibility errors for plugins