BootstrapWorker

@vendure/core Source

Bootstraps a Vendure worker. Resolves to a VendureWorker object containing a reference to the underlying NestJs standalone application as well as convenience methods for starting the job queue and health check server.

Read more about the Vendure Worker.

Example

import { bootstrapWorker } from '@vendure/core';import { config } from './vendure-config';bootstrapWorker(config)  .then(worker => worker.startJobQueue())  .then(worker => worker.startHealthCheckServer({ port: 3020 }))  .catch(err => {    console.log(err);    process.exit(1);  });

Signature

function bootstrapWorker(userConfig: Partial<VendureConfig>, options?: BootstrapWorkerOptions): Promise<VendureWorker>

Parameters

userConfig

parameterPartial<VendureConfig>

options

parameterBootstrapWorkerOptions

@vendure/core Sourcev2.2.0

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

Signature

interface BootstrapWorkerOptions {    nestApplicationContextOptions?: NestApplicationContextOptions;    ignoreCompatibilityErrorsForPlugins?: Array<DynamicModule | Type<any>>;}

nestApplicationContextOptions

propertyNestApplicationContextOptions

These options get passed directly to the NestFactory.createApplicationContext method.

ignoreCompatibilityErrorsForPlugins

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

Default:[]

See the ignoreCompatibilityErrorsForPlugins option in BootstrapOptions.