DefaultSearchPlugin

DefaultSearchPlugin

The DefaultSearchPlugin provides a full-text Product search based on the full-text searching capabilities of the underlying database.

The DefaultSearchPlugin is bundled with the @vendure/core package. If you are not using an alternative search plugin, then make sure this one is used, otherwise you will not be able to search products via the search query.

Example

import { DefaultSearchPlugin, VendureConfig } from '@vendure/core';

export const config: VendureConfig = {
  // Add an instance of the plugin to the plugins array
  plugins: [
    DefaultSearchPlugin.init({
      indexStockStatus: true,
      bufferUpdates: true,
    }),
  ],
};

Signature

class DefaultSearchPlugin implements OnApplicationBootstrap, OnApplicationShutdown {
  static static options: DefaultSearchPluginInitOptions = {};
  static init(options: DefaultSearchPluginInitOptions) => Type<DefaultSearchPlugin>;
}

Implements

• OnApplicationBootstrap
• OnApplicationShutdown

Members

options

init

Contents:

• DefaultSearchPluginInitOptions