Bootstrap

bootstrap

Bootstraps the Vendure server. This is the entry point to the application.

Example

import { bootstrap } from '@vendure/core';import { config } from './vendure-config';bootstrap(config).catch(err => {  console.log(err);  process.exit(1);});

Passing additional options

Since v2.2.0, you can pass additional options to the NestJs application via the options parameter. For example, to integrate with the Nest Devtools, you need to pass the snapshot option:

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);});

Ignoring compatibility errors for plugins

Since v3.1.0, you can ignore compatibility errors for specific plugins by passing the ignoreCompatibilityErrorsForPlugins option.

This 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, {  // 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

function bootstrap(userConfig: Partial<VendureConfig>, options?: BootstrapOptions): Promise<INestApplication>

Parameters

userConfig

parameterPartial<VendureConfig>

options

parameterBootstrapOptions

BootstrapOptions

@vendure/core Sourcev2.2.0

Additional options that can be used to configure the bootstrap process of the Vendure server.

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); }});

Was this chapter helpful?

Report Issue

Edited Apr 20, 2026·Edit this page