Merge pull request #3150 from aarontravass/aaron/jsdoc

docs(graphql): added jsdoc for debug and introspection. closes #3142
nestjs · Jul 2, 2024 · 6be01d7 · 6be01d7
2 parents 236a4e8 + aeab817
commit 6be01d7
Show file tree

Hide file tree

Showing 3 changed files with 23 additions and 5 deletions.
diff --git a/packages/graphql/lib/interfaces/gql-module-options.interface.ts b/packages/graphql/lib/interfaces/gql-module-options.interface.ts
@@ -120,6 +120,20 @@ export interface GqlModuleOptions<TDriver extends GraphQLDriver = any> {
    * Extra static metadata to be loaded into the specification
    */
   metadata?: () => Promise<Record<string, any>>;
+
+  /**
+   * If `true`, enables development mode helpers and logs messages of all severity levels
+   * If `false`, only warn- and error-level messages are logged.
+   * @default true
+   */
+  debug?: boolean;
+
+  /**
+   * If `true`, enables schema introspection by clients. Default is `true` unless `NODE_ENV` is
+   * set to `production`
+   * @default true
+   */
+  introspection?: boolean;
 }
 
 export interface GqlOptionsFactory<

diff --git a/packages/graphql/lib/schema-builder/metadata/union.metadata.ts b/packages/graphql/lib/schema-builder/metadata/union.metadata.ts
@@ -1,7 +1,9 @@
 import { Type } from '@nestjs/common';
 import { ResolveTypeFn } from '../../interfaces';
 
-export interface UnionMetadata<T extends readonly Type<unknown>[] = readonly Type<unknown>[]> {
+export interface UnionMetadata<
+  T extends readonly Type<unknown>[] = readonly Type<unknown>[],
+> {
   name: string;
   typesFn: () => T;
   id?: symbol;

diff --git a/packages/graphql/lib/type-factories/create-union-type.factory.ts b/packages/graphql/lib/type-factories/create-union-type.factory.ts
@@ -13,7 +13,9 @@ import { TypeMetadataStorage } from '../schema-builder/storages/type-metadata.st
 /**
  * Interface defining options that can be passed to `createUnionType` function.
  */
-export interface UnionOptions<T extends readonly Type<unknown>[] = Type<unknown>[]> {
+export interface UnionOptions<
+  T extends readonly Type<unknown>[] = Type<unknown>[],
+> {
   /**
    * Name of the union.
    */
@@ -40,9 +42,9 @@ export type Union<T extends readonly any[]> = InstanceType<ArrayElement<T>>;
  * Creates a GraphQL union type composed of types references.
  * @param options
  */
-export function createUnionType<T extends readonly Type<unknown>[] = Type<unknown>[]>(
-  options: UnionOptions<T>,
-): Union<T> {
+export function createUnionType<
+  T extends readonly Type<unknown>[] = Type<unknown>[],
+>(options: UnionOptions<T>): Union<T> {
   const { name, description, types, resolveType } = options;
   const id = Symbol(name);