Extensibility & developer surface — found from sitemap — Vendure

Cited by

Facts read from this source

• Plugin system Report an error

  “The heart of Vendure is its plugin system. Plugins not only allow you to instantly add new functionality to your Vendure server via third-party npm packages, they are also the means by which you build out the custom business logic of your application.”

• Plugin capabilities Report an error

  “Plugins in Vendure allow one to: Modify the VendureConfig object, such as defining custom fields on existing entities. Extend the GraphQL APIs, including modifying existing types and adding completely new queries and mutations. Define new database entities and interact directly with the database. Interact with external systems that you need to integrate with. Respond to events such as new orders being placed. Trigger background tasks to run on the worker process.”

• Nestjs compatibility Report an error

  “Since a Vendure plugin is a superset of a NestJS module, this means that many NestJS modules are actually valid Vendure plugins!”

• Core plugins Report an error

  “Vendure provides a set of core plugins covering common functionality such as assets handling, email sending, and search.”

• Cli plugin creation Report an error

  “Run the npx vendure add command, and select "Create a new Vendure plugin". This will guide you through the creation of a new plugin and automate all aspects of the process. This is the recommended way of creating a new plugin.”

• Plugin version compatibility Report an error

  “Since Vendure v2.0.0, it is possible for a plugin to specify which versions of the Vendure Framework it is compatible with.”

• Plugin lifecycle hooks Report an error

  “Since a VendurePlugin is built on top of the NestJS module system, any plugin (as well as any providers it defines) can make use of any of the NestJS lifecycle hooks: onModuleInit onApplicationBootstrap onModuleDestroy beforeApplicationShutdown onApplicationShutdown”

• Plugin server worker both Report an error

  “Note that lifecycle hooks are run in both the server and worker contexts.”

• Plugin rest endpoints Report an error

  “controllers: Controllers allow the plugin to define REST-style endpoints.”

• Plugin graphql extensions Report an error

  “shopApiExtensions: Allows the plugin to extend the GraphQL Shop API with new queries, mutations, resolvers & scalars. adminApiExtensions: Allows the plugin to extend the GraphQL Admin API with new queries, mutations, resolvers & scalars.”

• Plugin entities Report an error

  “entities: Allows the plugin to define new database entities.”

• Orm typeorm Report an error

  “Vendure uses TypeORM to manage the database schema, and an Entity corresponds to a database table.”

• Plugin publishing Report an error

  “If you have created a plugin that you would like to share with the community, you can publish it to npm, and even have it listed on the Vendure Hub.”

• Version current Report an error

  “v3.8.1 (Current)”

• Database migrations required Report an error

  “Since we have defined a custom field, we'll need to generate and run a migration to add the new column to the database.”

Scores citing this record

• The B2B Seller Extensibility & developer surface
• The Data Protection Officer Extensibility & developer surface
• The Developer Extensibility & developer surface
• The Merchant Extensibility & developer surface
• The Operations Lead Extensibility & developer surface
• The Skeptic Extensibility & developer surface