From 6d09ceb3dcdded5ecd9ac341a01ed846a6e23070 Mon Sep 17 00:00:00 2001 From: Philipp Sonntag Date: Fri, 6 Dec 2024 10:19:24 +0100 Subject: [PATCH] chore(core): Added comment to explain what the passed schema is --- packages/core/src/plugin/vendure-plugin.ts | 3 +++ 1 file changed, 3 insertions(+) diff --git a/packages/core/src/plugin/vendure-plugin.ts b/packages/core/src/plugin/vendure-plugin.ts index 45c046c976..eb6277e1e7 100644 --- a/packages/core/src/plugin/vendure-plugin.ts +++ b/packages/core/src/plugin/vendure-plugin.ts @@ -80,6 +80,7 @@ export interface APIExtensionDefinition { /** * @description * Extensions to the schema. + * Passes the current schema as an optional argument, allowing the extension to be based on the existing schema. * * @example * ```ts @@ -97,6 +98,8 @@ export interface APIExtensionDefinition { * @description * An array of resolvers for the schema extensions. Should be defined as [Nestjs GraphQL resolver](https://docs.nestjs.com/graphql/resolvers-map) * classes, i.e. using the Nest `\@Resolver()` decorator etc. + * + * Passes the current schema as an optional argument, allowing the resolver to be based on the existing schema. */ resolvers?: Array> | (() => Array>) | ((schema?: GraphQLSchema) => Array>); /**