@nest-boot/graphql

Classes

abstract AbstractGraphQLDriver

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:8

Public Api

Type Parameters

Type Parameter
TOptions extends Record<string, any>

Implements

• GraphQLDriver<TOptions>

Constructors

Constructor

new AbstractGraphQLDriver<TOptions>(): AbstractGraphQLDriver<TOptions>;

Returns

AbstractGraphQLDriver<TOptions>

Properties

applicationConfig?

protected readonly optional applicationConfig: ApplicationConfig;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:10

graphQlFactory

protected readonly graphQlFactory: GraphQLFactory;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:11

httpAdapterHost

protected readonly httpAdapterHost: HttpAdapterHost;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:9

Methods

generateSchema()

generateSchema(options): Promise<GraphQLSchema> | null;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:15

Parameters

Parameter	Type
options	TOptions

Returns

Promise<GraphQLSchema> | null

getNormalizedPath()

protected getNormalizedPath(options): string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:17

Parameters

Parameter	Type
options	TOptions

Returns

string

mergeDefaultOptions()

mergeDefaultOptions(options, defaults?): Promise<TOptions>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:14

Parameters

Parameter	Type
options	TOptions
defaults?	Record<string, any>

Returns

Promise<TOptions>

start()

abstract start(options): Promise<unknown>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:12

Parameters

Parameter	Type
options	TOptions

Returns

Promise<unknown>

Implementation of

GraphQLDriver.start

stop()

abstract stop(): Promise<void>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:13

Returns

Promise<void>

Implementation of

GraphQLDriver.stop

subscriptionWithFilter()

subscriptionWithFilter(
   instanceRef, 
   filterFn, 
   createSubscribeContext): any;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:16

Parameters

Parameter	Type
instanceRef	unknown
filterFn	(payload, variables, context) => boolean | Promise<boolean>
createSubscribeContext	Function

Returns

any

---

BaseExplorerService

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/base-explorer.service.d.ts:4

Constructors

Constructor

new BaseExplorerService(): BaseExplorerService;

Returns

BaseExplorerService

Methods

flatMap()

flatMap<T>(modules, callback): T[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/base-explorer.service.d.ts:7

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
modules	Module[]
callback	(instance, moduleRef) => T | T[]

Returns

T[]

getModules()

getModules(modulesContainer, include): Module[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/base-explorer.service.d.ts:5

Parameters

Parameter	Type
modulesContainer	Map<string, Module> | undefined
include	Function[]

Returns

Module[]

groupMetadata()

groupMetadata(resolvers): any;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/base-explorer.service.d.ts:8

Parameters

Parameter	Type
resolvers	ResolverMetadata[]

Returns

any

includeWhitelisted()

includeWhitelisted(modulesContainer, include): Module[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/base-explorer.service.d.ts:6

Parameters

Parameter	Type
modulesContainer	Map<string, Module>
include	Function[]

Returns

Module[]

---

FileSystemHelper

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/helpers/file-system.helper.d.ts:1

Constructors

Constructor

new FileSystemHelper(): FileSystemHelper;

Returns

FileSystemHelper

Methods

getDirs()

getDirs(path): string[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/helpers/file-system.helper.d.ts:4

Parameters

Parameter	Type
path	string

Returns

string[]

mkdirRecursive()

mkdirRecursive(path): Promise<void>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/helpers/file-system.helper.d.ts:3

Parameters

Parameter	Type
path	string

Returns

Promise<void>

writeFile()

writeFile(path, content): Promise<void>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/helpers/file-system.helper.d.ts:2

Parameters

Parameter	Type
path	string
content	string

Returns

Promise<void>

---

GqlArgumentsHost

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:9

Extends

• ExecutionContextHost

Implements

• GraphQLArgumentsHost

Constructors

Constructor

new GqlArgumentsHost(
   args, 
   constructorRef?, 
   handler?): GqlArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:9

Parameters

Parameter	Type
args	any[]
constructorRef?	Type<any> | null
handler?	Function | null

Returns

GqlArgumentsHost

Inherited from

ExecutionContextHost.constructor

Methods

getArgByIndex()

getArgByIndex<T>(index): T;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:15

Returns a particular argument by index.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
index	number	index of argument to retrieve

Returns

T

Implementation of

GraphQLArgumentsHost.getArgByIndex

Inherited from

ExecutionContextHost.getArgByIndex

getArgs()

getArgs<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:12

Returns the array of arguments being passed to the handler.

Type Parameters

Type Parameter
T

Returns

T

Implementation of

GraphQLArgumentsHost.getArgs

Overrides

ExecutionContextHost.getArgs

getClass()

getClass<T>(): Type<T>;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:12

Returns the type of the controller class which the current handler belongs to.

Type Parameters

Type Parameter
T

Returns

Type<T>

Inherited from

ExecutionContextHost.getClass

getContext()

getContext<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:13

Type Parameters

Type Parameter
T

Returns

T

Implementation of

GraphQLArgumentsHost.getContext

getHandler()

getHandler(): Function;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:13

Returns a reference to the handler (method) that will be invoked next in the request pipeline.

Returns

Function

Inherited from

ExecutionContextHost.getHandler

getInfo()

getInfo<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:14

Type Parameters

Type Parameter
T

Returns

T

Implementation of

GraphQLArgumentsHost.getInfo

getRoot()

getRoot<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:11

Type Parameters

Type Parameter
T

Returns

T

Implementation of

GraphQLArgumentsHost.getRoot

getType()

getType<TContext>(): TContext;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:11

Returns the current execution context type (string)

Type Parameters

Type Parameter
TContext extends string

Returns

TContext

Implementation of

GraphQLArgumentsHost.getType

Inherited from

ExecutionContextHost.getType

setType()

setType<TContext>(type): void;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:10

Type Parameters

Type Parameter
TContext extends string

Parameters

Parameter	Type
type	TContext

Returns

void

Inherited from

ExecutionContextHost.setType

switchToHttp()

switchToHttp(): HttpArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:17

Switch context to HTTP.

Returns

HttpArgumentsHost

interface with methods to retrieve HTTP arguments

Implementation of

GraphQLArgumentsHost.switchToHttp

Inherited from

ExecutionContextHost.switchToHttp

switchToRpc()

switchToRpc(): RpcArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:16

Switch context to RPC.

Returns

RpcArgumentsHost

interface with methods to retrieve RPC arguments

Implementation of

GraphQLArgumentsHost.switchToRpc

Inherited from

ExecutionContextHost.switchToRpc

switchToWs()

switchToWs(): WsArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:18

Switch context to WebSockets.

Returns

WsArgumentsHost

interface with methods to retrieve WebSockets arguments

Implementation of

GraphQLArgumentsHost.switchToWs

Inherited from

ExecutionContextHost.switchToWs

create()

static create(context): GqlArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:10

Parameters

Parameter	Type
context	ArgumentsHost

Returns

GqlArgumentsHost

---

GqlExecutionContext

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-execution-context.d.ts:6

Extends

• ExecutionContextHost

Implements

• GraphQLArgumentsHost

Constructors

Constructor

new GqlExecutionContext(
   args, 
   constructorRef?, 
   handler?): GqlExecutionContext;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:9

Parameters

Parameter	Type
args	any[]
constructorRef?	Type<any> | null
handler?	Function | null

Returns

GqlExecutionContext

Inherited from

ExecutionContextHost.constructor

Methods

getArgByIndex()

getArgByIndex<T>(index): T;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:15

Returns a particular argument by index.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
index	number	index of argument to retrieve

Returns

T

Implementation of

GraphQLArgumentsHost.getArgByIndex

Inherited from

ExecutionContextHost.getArgByIndex

getArgs()

getArgs<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-execution-context.d.ts:10

Returns the array of arguments being passed to the handler.

Type Parameters

Type Parameter
T

Returns

T

Implementation of

GraphQLArgumentsHost.getArgs

Overrides

ExecutionContextHost.getArgs

getClass()

getClass<T>(): Type<T>;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:12

Returns the type of the controller class which the current handler belongs to.

Type Parameters

Type Parameter
T

Returns

Type<T>

Inherited from

ExecutionContextHost.getClass

getContext()

getContext<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-execution-context.d.ts:11

Type Parameters

Type Parameter
T

Returns

T

Implementation of

GraphQLArgumentsHost.getContext

getHandler()

getHandler(): Function;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:13

Returns a reference to the handler (method) that will be invoked next in the request pipeline.

Returns

Function

Inherited from

ExecutionContextHost.getHandler

getInfo()

getInfo<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-execution-context.d.ts:12

Type Parameters

Type Parameter
T

Returns

T

Implementation of

GraphQLArgumentsHost.getInfo

getRoot()

getRoot<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-execution-context.d.ts:9

Type Parameters

Type Parameter
T

Returns

T

Implementation of

GraphQLArgumentsHost.getRoot

getType()

getType<TContext>(): TContext;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-execution-context.d.ts:8

Returns the current execution context type (string)

Type Parameters

Type Parameter
TContext extends string

Returns

TContext

Implementation of

GraphQLArgumentsHost.getType

Overrides

ExecutionContextHost.getType

setType()

setType<TContext>(type): void;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:10

Type Parameters

Type Parameter
TContext extends string

Parameters

Parameter	Type
type	TContext

Returns

void

Inherited from

ExecutionContextHost.setType

switchToHttp()

switchToHttp(): HttpArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:17

Switch context to HTTP.

Returns

HttpArgumentsHost

interface with methods to retrieve HTTP arguments

Implementation of

GraphQLArgumentsHost.switchToHttp

Inherited from

ExecutionContextHost.switchToHttp

switchToRpc()

switchToRpc(): RpcArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:16

Switch context to RPC.

Returns

RpcArgumentsHost

interface with methods to retrieve RPC arguments

Implementation of

GraphQLArgumentsHost.switchToRpc

Inherited from

ExecutionContextHost.switchToRpc

switchToWs()

switchToWs(): WsArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/helpers/execution-context-host.d.ts:18

Switch context to WebSockets.

Returns

WsArgumentsHost

interface with methods to retrieve WebSockets arguments

Implementation of

GraphQLArgumentsHost.switchToWs

Inherited from

ExecutionContextHost.switchToWs

create()

static create(context): GqlExecutionContext;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-execution-context.d.ts:7

Parameters

Parameter	Type
context	ExecutionContext

Returns

GqlExecutionContext

---

GqlSubscriptionService

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:21

Constructors

Constructor

new GqlSubscriptionService(options, httpServer): GqlSubscriptionService;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:28

Parameters

Parameter	Type
options	GqlSubscriptionServiceOptions
httpServer	any

Returns

GqlSubscriptionService

Methods

stop()

stop(): Promise<void>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:30

Returns

Promise<void>

---

GraphQLAstExplorer

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:49

Constructors

Constructor

new GraphQLAstExplorer(): GraphQLAstExplorer;

Returns

GraphQLAstExplorer

Methods

addSymbolIfRoot()

addSymbolIfRoot(name): string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:73

Parameters

Parameter	Type
name	string

Returns

string

explore()

explore(
   documentNode, 
   outputPath, 
   mode, 
options?): Promise<SourceFile>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:51

Parameters

Parameter	Type
documentNode	DocumentNode
outputPath	string
mode	"class" | "interface"
options?	DefinitionsGeneratorOptions

Returns

Promise<SourceFile>

getDefaultTypes()

getDefaultTypes(options): {
[type: string]: string;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:66

Parameters

Parameter	Type
options	DefinitionsGeneratorOptions

Returns

{
[type: string]: string;
}

getFieldTypeDefinition()

getFieldTypeDefinition(typeNode, options): {
  name: string;
  required: boolean;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:57

Parameters

Parameter	Type
typeNode	TypeNode
options	DefinitionsGeneratorOptions

Returns

{
  name: string;
  required: boolean;
}

name

name: string;

required

required: boolean;

getFunctionParameters()

getFunctionParameters(inputs, options): ParameterDeclarationStructure[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:69

Parameters

Parameter	Type
inputs	readonly InputValueDefinitionNode[]
options	DefinitionsGeneratorOptions

Returns

ParameterDeclarationStructure[]

getType()

getType(typeName, options): string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:65

Parameters

Parameter	Type
typeName	string
options	DefinitionsGeneratorOptions

Returns

string

isRoot()

isRoot(name): boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:74

Parameters

Parameter	Type
name	string

Returns

boolean

toDefinitionStructures()

toDefinitionStructures(
   item, 
   mode, 
   options): 
  | ClassDeclarationStructure
  | EnumDeclarationStructure
  | InterfaceDeclarationStructure
  | TypeAliasDeclarationStructure;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:52

Parameters

Parameter	Type
item	Readonly<TypeSystemDefinitionNode | TypeSystemExtensionNode>
mode	"class" | "interface"
options	DefinitionsGeneratorOptions

Returns

| ClassDeclarationStructure | EnumDeclarationStructure | InterfaceDeclarationStructure | TypeAliasDeclarationStructure

toEnumDefinitionStructure()

toEnumDefinitionStructure(item, options): EnumDeclarationStructure | TypeAliasDeclarationStructure;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:71

Parameters

Parameter	Type
item	EnumTypeDefinitionNode | EnumTypeExtensionNode
options	DefinitionsGeneratorOptions

Returns

EnumDeclarationStructure | TypeAliasDeclarationStructure

toMethodDeclarationStructure()

toMethodDeclarationStructure(
   item, 
   mode, 
   options): Pick<MethodDeclarationStructure, 
  | "name"
  | "leadingTrivia"
  | "trailingTrivia"
  | "hasQuestionToken"
  | "isStatic"
  | "scope"
  | "docs"
  | "decorators"
  | "isAbstract"
  | "hasOverrideKeyword"
  | "overloads"
  | "isAsync"
  | "isGenerator"
  | "parameters"
  | "returnType"
  | "typeParameters"
  | "statements"> & Partial<Pick<MethodDeclarationStructure, "kind">> & Pick<MethodSignatureStructure, 
  | "name"
  | "leadingTrivia"
  | "trailingTrivia"
  | "hasQuestionToken"
  | "docs"
  | "parameters"
  | "returnType"
| "typeParameters"> & Partial<Pick<MethodSignatureStructure, "kind">>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:56

Parameters

Parameter	Type
item	FieldDefinitionNode | InputValueDefinitionNode
mode	"class" | "interface"
options	DefinitionsGeneratorOptions

Returns

Pick<MethodDeclarationStructure, | "name" | "leadingTrivia" | "trailingTrivia" | "hasQuestionToken" | "isStatic" | "scope" | "docs" | "decorators" | "isAbstract" | "hasOverrideKeyword" | "overloads" | "isAsync" | "isGenerator" | "parameters" | "returnType" | "typeParameters" | "statements"> & Partial<Pick<MethodDeclarationStructure, "kind">> & Pick<MethodSignatureStructure, | "name" | "leadingTrivia" | "trailingTrivia" | "hasQuestionToken" | "docs" | "parameters" | "returnType" | "typeParameters"> & Partial<Pick<MethodSignatureStructure, "kind">>

toObjectTypeDefinitionStructure()

toObjectTypeDefinitionStructure(
   item, 
   mode, 
   options): ClassDeclarationStructure | InterfaceDeclarationStructure;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:54

Parameters

Parameter	Type
item	| ObjectTypeDefinitionNode | InterfaceTypeDefinitionNode | InputObjectTypeDefinitionNode | ObjectTypeExtensionNode | InterfaceTypeExtensionNode | InputObjectTypeExtensionNode
mode	"class" | "interface"
options	DefinitionsGeneratorOptions

Returns

ClassDeclarationStructure | InterfaceDeclarationStructure

toPropertyDeclarationStructure()

toPropertyDeclarationStructure(item, options): Pick<PropertyDeclarationStructure, 
  | "name"
  | "leadingTrivia"
  | "trailingTrivia"
  | "hasAccessorKeyword"
  | "type"
  | "hasQuestionToken"
  | "hasExclamationToken"
  | "isStatic"
  | "scope"
  | "docs"
  | "isReadonly"
  | "initializer"
  | "decorators"
  | "isAbstract"
  | "hasDeclareKeyword"
  | "hasOverrideKeyword"> & Partial<Pick<PropertyDeclarationStructure, "kind">> & Pick<PropertySignatureStructure, 
  | "name"
  | "leadingTrivia"
  | "trailingTrivia"
  | "type"
  | "hasQuestionToken"
  | "docs"
  | "isReadonly"
| "initializer"> & Partial<Pick<PropertySignatureStructure, "kind">>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:55

Parameters

Parameter	Type
item	FieldDefinitionNode | InputValueDefinitionNode
options	DefinitionsGeneratorOptions

Returns

Pick<PropertyDeclarationStructure, | "name" | "leadingTrivia" | "trailingTrivia" | "hasAccessorKeyword" | "type" | "hasQuestionToken" | "hasExclamationToken" | "isStatic" | "scope" | "docs" | "isReadonly" | "initializer" | "decorators" | "isAbstract" | "hasDeclareKeyword" | "hasOverrideKeyword"> & Partial<Pick<PropertyDeclarationStructure, "kind">> & Pick<PropertySignatureStructure, | "name" | "leadingTrivia" | "trailingTrivia" | "type" | "hasQuestionToken" | "docs" | "isReadonly" | "initializer"> & Partial<Pick<PropertySignatureStructure, "kind">>

toRootSchemaDefinitionStructure()

toRootSchemaDefinitionStructure(operationTypes, mode): ClassDeclarationStructure | InterfaceDeclarationStructure;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:53

Parameters

Parameter	Type
operationTypes	readonly OperationTypeDefinitionNode[]
mode	"class" | "interface"

Returns

ClassDeclarationStructure | InterfaceDeclarationStructure

toScalarDefinitionStructure()

toScalarDefinitionStructure(item, options): TypeAliasDeclarationStructure;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:70

Parameters

Parameter	Type
item	ScalarTypeDefinitionNode | ScalarTypeExtensionNode
options	DefinitionsGeneratorOptions

Returns

TypeAliasDeclarationStructure

toUnionDefinitionStructure()

toUnionDefinitionStructure(item, options): TypeAliasDeclarationStructure;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:72

Parameters

Parameter	Type
item	UnionTypeDefinitionNode | UnionTypeExtensionNode
options	DefinitionsGeneratorOptions

Returns

TypeAliasDeclarationStructure

unwrapTypeIfNonNull()

unwrapTypeIfNonNull(type): {
  required: boolean;
  type: TypeNode;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:61

Parameters

Parameter	Type
type	TypeNode

Returns

{
  required: boolean;
  type: TypeNode;
}

required

required: boolean;

type

type: TypeNode;

---

GraphQLDefinitionsFactory

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:11

Extended by

• GraphQLFederationDefinitionsFactory

Constructors

Constructor

new GraphQLDefinitionsFactory(): GraphQLDefinitionsFactory;

Returns

GraphQLDefinitionsFactory

Properties

gqlAstExplorer

protected readonly gqlAstExplorer: GraphQLAstExplorer;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:12

gqlTypesLoader

protected readonly gqlTypesLoader: GraphQLTypesLoader;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:13

Methods

exploreAndEmit()

protected exploreAndEmit(
   typePaths, 
   path, 
   outputAs, 
   isDebugEnabled, 
   definitionsGeneratorOptions, 
typeDefs?): Promise<void>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:15

Parameters

Parameter	Type
typePaths	string[]
path	string
outputAs	"class" | "interface"
isDebugEnabled	boolean
definitionsGeneratorOptions	DefinitionsGeneratorOptions
typeDefs?	string | string[]

Returns

Promise<void>

generate()

generate(options): Promise<void>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:14

Parameters

Parameter	Type
options	GenerateOptions

Returns

Promise<void>

printMessage()

protected printMessage(text, isEnabled): void;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:16

Parameters

Parameter	Type
text	string
isEnabled	boolean

Returns

void

---

GraphQLExceptionFilter

Defined in: packages/graphql/src/graphql.exception-filter.ts:14

Interface defining a GraphQL exception filter.

Public Api

Extends

• BaseExceptionFilter

Implements

• GqlExceptionFilter

Constructors

Constructor

new GraphQLExceptionFilter(logger): GraphQLExceptionFilter;

Defined in: packages/graphql/src/graphql.exception-filter.ts:20

Parameters

Parameter	Type
logger	Logger

Returns

GraphQLExceptionFilter

Overrides

BaseExceptionFilter.constructor

Properties

applicationRef?

protected readonly optional applicationRef: HttpServer<any, any, any>;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/exceptions/base-exception-filter.d.ts:5

Inherited from

BaseExceptionFilter.applicationRef

httpAdapterHost?

protected readonly optional httpAdapterHost: HttpAdapterHost<AbstractHttpAdapter<any, any, any>>;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/exceptions/base-exception-filter.d.ts:7

Inherited from

BaseExceptionFilter.httpAdapterHost

Methods

catch()

catch(error, host): GraphQLError | undefined;

Defined in: packages/graphql/src/graphql.exception-filter.ts:24

Parameters

Parameter	Type
error	Error
host	ArgumentsHost

Returns

GraphQLError | undefined

Implementation of

GqlExceptionFilter.catch

Overrides

BaseExceptionFilter.catch

handleUnknownError()

handleUnknownError(
   exception, 
   host, 
   applicationRef): void;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/exceptions/base-exception-filter.d.ts:10

Parameters

Parameter	Type
exception	any
host	ArgumentsHost
applicationRef	| HttpServer<any, any, any> | AbstractHttpAdapter<any, any, any>

Returns

void

Inherited from

BaseExceptionFilter.handleUnknownError

isExceptionObject()

isExceptionObject(err): err is Error;

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/exceptions/base-exception-filter.d.ts:11

Parameters

Parameter	Type
err	any

Returns

err is Error

Inherited from

BaseExceptionFilter.isExceptionObject

isHttpError()

isHttpError(err): err is { message: string; statusCode: number };

Defined in: node_modules/.pnpm/@nestjs+core@11.1.9/node_modules/@nestjs/core/exceptions/base-exception-filter.d.ts:16

Checks if the thrown error comes from the "http-errors" library.

Parameters

Parameter	Type	Description
err	any	error object

Returns

err is { message: string; statusCode: number }

Inherited from

BaseExceptionFilter.isHttpError

transform()

transform(error): GraphQLError;

Defined in: packages/graphql/src/graphql.exception-filter.ts:35

Parameters

Parameter	Type
error	Error

Returns

GraphQLError

---

GraphQLFactory

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.factory.d.ts:6

Constructors

Constructor

new GraphQLFactory(
   resolversExplorerService, 
   scalarsExplorerService, 
   graphqlAstExplorer, 
   gqlSchemaBuilder): GraphQLFactory;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.factory.d.ts:11

Parameters

Parameter	Type
resolversExplorerService	ResolversExplorerService
scalarsExplorerService	ScalarsExplorerService
graphqlAstExplorer	GraphQLAstExplorer
gqlSchemaBuilder	GraphQLSchemaBuilder

Returns

GraphQLFactory

Methods

generateDefinitions()

generateDefinitions(typeDefs, options): Promise<void>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.factory.d.ts:14

Parameters

Parameter	Type
typeDefs	string | string[]
options	GqlModuleOptions

Returns

Promise<void>

generateSchema()

generateSchema<T>(options?): Promise<GraphQLSchema>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.factory.d.ts:12

Type Parameters

Type Parameter
T extends GqlModuleOptions<any>

Parameters

Parameter	Type
options?	T

Returns

Promise<GraphQLSchema>

---

GraphQLFederationDefinitionsFactory

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/federation/graphql-federation-definitions.factory.d.ts:6

Public Api

Extends

• GraphQLDefinitionsFactory

Constructors

Constructor

new GraphQLFederationDefinitionsFactory(): GraphQLFederationDefinitionsFactory;

Returns

GraphQLFederationDefinitionsFactory

Inherited from

GraphQLDefinitionsFactory.constructor

Properties

gqlAstExplorer

protected readonly gqlAstExplorer: GraphQLAstExplorer;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:12

Inherited from

GraphQLDefinitionsFactory.gqlAstExplorer

gqlTypesLoader

protected readonly gqlTypesLoader: GraphQLTypesLoader;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:13

Inherited from

GraphQLDefinitionsFactory.gqlTypesLoader

Methods

exploreAndEmit()

protected exploreAndEmit(
   typePaths, 
   path, 
   outputAs, 
   isDebugEnabled, 
   definitionsGeneratorOptions, 
typeDefs?): Promise<void>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/federation/graphql-federation-definitions.factory.d.ts:7

Parameters

Parameter	Type
typePaths	string[]
path	string
outputAs	"class" | "interface"
isDebugEnabled	boolean
definitionsGeneratorOptions	DefinitionsGeneratorOptions
typeDefs?	string | string[]

Returns

Promise<void>

Overrides

GraphQLDefinitionsFactory.exploreAndEmit

generate()

generate(options): Promise<void>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:14

Parameters

Parameter	Type
options	GenerateOptions

Returns

Promise<void>

Inherited from

GraphQLDefinitionsFactory.generate

printMessage()

protected printMessage(text, isEnabled): void;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:16

Parameters

Parameter	Type
text	string
isEnabled	boolean

Returns

void

Inherited from

GraphQLDefinitionsFactory.printMessage

---

GraphQLFederationFactory

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/federation/graphql-federation.factory.d.ts:9

Public Api

Constructors

Constructor

new GraphQLFederationFactory(
   resolversExplorerService, 
   scalarsExplorerService, 
   gqlSchemaBuilder, 
   typeDefsDecoratorFactory): GraphQLFederationFactory;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/federation/graphql-federation.factory.d.ts:14

Parameters

Parameter	Type
resolversExplorerService	ResolversExplorerService
scalarsExplorerService	ScalarsExplorerService
gqlSchemaBuilder	GraphQLSchemaBuilder
typeDefsDecoratorFactory	TypeDefsDecoratorFactory

Returns

GraphQLFederationFactory

Methods

buildFederatedSchema()

buildFederatedSchema<T>(
   autoSchemaFile, 
   options, 
resolvers): Promise<GraphQLSchema>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/federation/graphql-federation.factory.d.ts:26

Type Parameters

Type Parameter
T extends GqlModuleOptions<any>

Parameters

Parameter	Type
autoSchemaFile	AutoSchemaFileValue
options	T
resolvers	Function[]

Returns

Promise<GraphQLSchema>

generateSchema()

generateSchema<T>(options?, buildFederatedSchema?): Promise<GraphQLSchema>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/federation/graphql-federation.factory.d.ts:15

Type Parameters

Type Parameter
T extends GqlModuleOptions<any>

Parameters

Parameter	Type
options?	T
buildFederatedSchema?	(options) => GraphQLSchema

Returns

Promise<GraphQLSchema>

---

GraphQLModule

Defined in: packages/graphql/src/graphql.module.ts:52

Extends

• ConfigurableModuleClass

Indexable

[key: string]: any

Constructors

Constructor

new GraphQLModule(): GraphQLModule;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/module-utils/interfaces/configurable-module-cls.interface.d.ts:12

Returns

GraphQLModule

Inherited from

ConfigurableModuleClass.constructor

Properties

forRoot()

static forRoot: (options) => DynamicModule;

Parameters

Parameter	Type
options	ApolloDriverConfig & Partial<{ }>

Returns

DynamicModule

Inherited from

ConfigurableModuleClass.forRoot

forRootAsync()

static forRootAsync: (options) => DynamicModule;

Parameters

Parameter	Type
options	ConfigurableModuleAsyncOptions<ApolloDriverConfig, "create"> & Partial<{ }>

Returns

DynamicModule

Inherited from

ConfigurableModuleClass.forRootAsync

---

GraphQLSchemaBuilderModule

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/schema-builder.module.d.ts:1

Constructors

Constructor

new GraphQLSchemaBuilderModule(): GraphQLSchemaBuilderModule;

Returns

GraphQLSchemaBuilderModule

---

GraphQLSchemaFactory

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/graphql-schema.factory.d.ts:8

Constructors

Constructor

new GraphQLSchemaFactory(
   queryTypeFactory, 
   mutationTypeFactory, 
   subscriptionTypeFactory, 
   orphanedTypesFactory, 
   typeDefinitionsGenerator): GraphQLSchemaFactory;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/graphql-schema.factory.d.ts:15

Parameters

Parameter	Type
queryTypeFactory	QueryTypeFactory
mutationTypeFactory	MutationTypeFactory
subscriptionTypeFactory	SubscriptionTypeFactory
orphanedTypesFactory	OrphanedTypesFactory
typeDefinitionsGenerator	TypeDefinitionsGenerator

Returns

GraphQLSchemaFactory

Methods

create()

Call Signature

create(resolvers): Promise<GraphQLSchema>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/graphql-schema.factory.d.ts:16

Parameters

Parameter	Type
resolvers	Function[]

Returns

Promise<GraphQLSchema>

Call Signature

create(resolvers, scalarClasses): Promise<GraphQLSchema>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/graphql-schema.factory.d.ts:17

Parameters

Parameter	Type
resolvers	Function[]
scalarClasses	Function[]

Returns

Promise<GraphQLSchema>

Call Signature

create(resolvers, options): Promise<GraphQLSchema>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/graphql-schema.factory.d.ts:18

Parameters

Parameter	Type
resolvers	Function[]
options	BuildSchemaOptions

Returns

Promise<GraphQLSchema>

Call Signature

create(
   resolvers, 
   scalarClasses, 
options): Promise<GraphQLSchema>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/graphql-schema.factory.d.ts:19

Parameters

Parameter	Type
resolvers	Function[]
scalarClasses	Function[]
options	BuildSchemaOptions

Returns

Promise<GraphQLSchema>

---

GraphQLSchemaHost

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-schema.host.d.ts:2

Constructors

Constructor

new GraphQLSchemaHost(): GraphQLSchemaHost;

Returns

GraphQLSchemaHost

Accessors

schema

Get Signature

get schema(): GraphQLSchema;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-schema.host.d.ts:5

Returns

GraphQLSchema

Set Signature

set schema(schemaRef): void;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-schema.host.d.ts:4

Parameters

Parameter	Type
schemaRef	GraphQLSchema

Returns

void

---

GraphQLTypesLoader

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-types.loader.d.ts:1

Constructors

Constructor

new GraphQLTypesLoader(): GraphQLTypesLoader;

Returns

GraphQLTypesLoader

Methods

mergeTypesByPaths()

mergeTypesByPaths(paths): Promise<string>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-types.loader.d.ts:2

Parameters

Parameter	Type
paths	string | string[]

Returns

Promise<string>

Interfaces

AliasDirectiveImport

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:1

Properties

as

as: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:3

name

name: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:2

---

BuildFederatedSchemaOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-federated-schema-options.interface.d.ts:2

Properties

resolvers

resolvers: any;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-federated-schema-options.interface.d.ts:4

typeDefs

typeDefs: DocumentNode;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-federated-schema-options.interface.d.ts:3

---

BuildSchemaOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:9

Properties

addNewlineAtEnd?

optional addNewlineAtEnd: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:47

Add new line at the end of the generated GraphQL SDL file

dateScalarMode?

optional dateScalarMode: DateScalarMode;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:14

Date scalar mode

Default

'isoDate'

directives?

optional directives: GraphQLDirective[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:35

GraphQL directives

fieldMiddleware?

optional fieldMiddleware: FieldMiddleware<any, any, {
[argName: string]: any;
}, any>[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:39

Array of global field middleware functions

noDuplicatedFields?

optional noDuplicatedFields: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:43

Set to true if it should throw an error when the same Query / Mutation field is defined more than once

numberScalarMode?

optional numberScalarMode: NumberScalarMode;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:19

Number scalar mode

Default

'float'

orphanedTypes?

optional orphanedTypes: (object | Function)[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:27

Orphaned type classes/enums that are not explicitly used in GraphQL types definitions

scalarsMap?

optional scalarsMap: ScalarsTypeMap[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:23

Scalars map

skipCheck?

optional skipCheck: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:31

Disable checking on build the correctness of a schema

---

CustomScalar

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/custom-scalar.interface.d.ts:2

Type Parameters

Type Parameter
T
K

Properties

description?

optional description: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/custom-scalar.interface.d.ts:3

parseLiteral

parseLiteral: GraphQLScalarLiteralParser<K>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/custom-scalar.interface.d.ts:6

parseValue

parseValue: GraphQLScalarValueParser<K>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/custom-scalar.interface.d.ts:4

serialize

serialize: GraphQLScalarSerializer<T>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/custom-scalar.interface.d.ts:5

---

DefinitionsGeneratorOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:3

Properties

additionalHeader?

optional additionalHeader: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:36

If provided, specifies a custom header to add after the to the output file (eg. for custom type imports or comments)

Default

undefined

customScalarTypeMapping?

optional customScalarTypeMapping: Record<string, 
  | string
  | {
  name: string;
}>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:23

If provided, specifies a mapping of types to use for custom scalars

Default

undefined

defaultScalarType?

optional defaultScalarType: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:18

If provided, specifies a default generated TypeScript type for custom scalars.

Default

'any'

defaultTypeMapping?

optional defaultTypeMapping: Partial<Record<"ID" | "Float" | "Int", "string" | "number"> & Record<"Boolean" | "String", "string" | "number" | "boolean">>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:30

If provided, specifies a mapping of default scalar types (Int, Boolean, ID, Float, String).

Default

undefined

emitTypenameField?

optional emitTypenameField: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:8

If true, the additional "__typename" field is generated for every object type.

Default

false

enumsAsTypes?

optional enumsAsTypes: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:41

If true, enums are generated as string literal union types.

Default

false

skipResolverArgs?

optional skipResolverArgs: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:13

If true, resolvers (query/mutation/etc) are generated as plain fields without arguments.

Default

false

typeName()?

optional typeName: (name) => string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-ast.explorer.d.ts:47

If provided, specifies a function to transform type names.

Parameters

Parameter	Type
name	string

Returns

string

Example

(name) => `${name}Schema`

Default

undefined

---

EnumOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/register-enum-type.factory.d.ts:11

Interface defining options that can be passed to registerEnumType function.

Type Parameters

Type Parameter
T extends object

Properties

description?

optional description: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/register-enum-type.factory.d.ts:19

Description of the enum.

name

name: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/register-enum-type.factory.d.ts:15

Name of the enum.

valuesMap?

optional valuesMap: Partial<Record<keyof T, EnumMetadataValuesMapOptions>>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/register-enum-type.factory.d.ts:23

A map of options for the values of the enum.

---

Federation2Config

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:7

Properties

directives?

optional directives: (string | AliasDirectiveImport)[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:13

The imported directives

Default

['@composeDirective', '@extends', '@external', '@inaccessible', '@interfaceObject', '@key', '@override', '@provides', '@requires', '@shareable', '@tag']

importUrl?

optional importUrl: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:18

The import link

Default

'https://specs.apollo.dev/federation/v2.3'

version

version: 2;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:8

---

FieldMiddleware()

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/field-middleware.interface.d.ts:11

Type Parameters

Type Parameter
TSource
TContext
TArgs
TOutput

FieldMiddleware(ctx, next): TOutput | Promise<TOutput>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/field-middleware.interface.d.ts:14

Parameters

Parameter	Type
ctx	MiddlewareContext<TSource, TContext, TArgs>
next	NextFn

Returns

TOutput | Promise<TOutput>

---

GqlExceptionFilter

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-exception-filter.interface.d.ts:7

Interface defining a GraphQL exception filter.

Public Api

Type Parameters

Type Parameter
TInput
TOutput

Methods

catch()

catch(exception, host): TOutput;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-exception-filter.interface.d.ts:8

Parameters

Parameter	Type
exception	TInput
host	ArgumentsHost

Returns

TOutput

---

GqlModuleAsyncOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:123

Extends

• Pick<ModuleMetadata, "imports">

Type Parameters

Type Parameter
TOptions extends Record<string, any>
TFactory

Properties

driver?

optional driver: TOptions["driver"];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:127

GraphQL server driver

imports?

optional imports: (
  | Type<any>
  | DynamicModule
  | Promise<DynamicModule>
  | ForwardReference<any>)[];

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/interfaces/modules/module-metadata.interface.d.ts:18

Optional list of imported modules that export the providers which are required in this module.

Inherited from

Pick.imports

inject?

optional inject: any[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:131

useClass?

optional useClass: Type<TFactory>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:129

useExisting?

optional useExisting: Type<TFactory>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:128

useFactory()?

optional useFactory: (...args) => 
  | Omit<TOptions, "driver">
| Promise<Omit<TOptions, "driver">>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:130

Parameters

Parameter	Type
...args	any[]

Returns

| Omit<TOptions, "driver"> | Promise<Omit<TOptions, "driver">>

---

GqlModuleOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:16

"GraphQLModule" options object.

Public Api

Type Parameters

Type Parameter
TDriver extends GraphQLDriver

Properties

autoSchemaFile?

optional autoSchemaFile: AutoSchemaFileValue;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:59

If enabled, GraphQL schema will be generated automatically

buildSchemaOptions?

optional buildSchemaOptions: BuildSchemaOptions;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:68

Options to be passed to the schema generator Only applicable if "autoSchemaFile" = true

context?

optional context: any;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:102

Context function

debug?

optional debug: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:112

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

definitions?

optional definitions: {
  outputAs?: "class" | "interface";
  path?: string;
} & DefinitionsGeneratorOptions;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:52

TypeScript definitions generator options

Type Declaration

outputAs?

optional outputAs: "class" | "interface";

path?

optional path: string;

directiveResolvers?

optional directiveResolvers: any;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:40

Directive resolvers

driver?

optional driver: Type<TDriver>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:32

GraphQL server adapter

fieldResolverEnhancers?

optional fieldResolverEnhancers: Enhancer[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:78

Enable/disable enhancers for @ResolveField()

include?

optional include: Function[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:36

An array of modules to scan when searching for resolvers

inheritResolversFromInterfaces?

optional inheritResolversFromInterfaces: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:86

Inherit missing resolvers from their interface types defined in the resolvers object.

introspection?

optional introspection: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:118

If true, enables schema introspection by clients. Default is true unless NODE_ENV is set to production

Default

true

metadata()?

optional metadata: () => Promise<Record<string, any>>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:106

Extra static metadata to be loaded into the specification

Returns

Promise<Record<string, any>>

path?

optional path: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:20

Path to mount GraphQL API

resolvers?

optional resolvers: IResolvers | IResolvers[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:48

Extra resolvers to be registered.

resolverValidationOptions?

optional resolverValidationOptions: IResolverValidationOptions;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:82

Resolver validation options.

schema?

optional schema: GraphQLSchema;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:44

Optional GraphQL schema (to be used or to be merged)

sortSchema?

optional sortSchema: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:63

Sort the schema lexicographically

transformAutoSchemaFile?

optional transformAutoSchemaFile: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:98

Apply transformSchema to the autoSchemaFile

transformResolvers()?

optional transformResolvers: (resolvers) => 
  | IResolvers
  | IResolvers[]
  | Promise<IResolvers>
| Promise<IResolvers[]>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:94

Function to be applied to the discovered resolvers letting you perform compositions.

Parameters

Parameter	Type
resolvers	IResolvers | IResolvers[]

Returns

| IResolvers | IResolvers[] | Promise<IResolvers> | Promise<IResolvers[]>

transformSchema()?

optional transformSchema: (schema) => GraphQLSchema | Promise<GraphQLSchema>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:90

Function to be applied to the schema letting you register custom transformations.

Parameters

Parameter	Type
schema	GraphQLSchema

Returns

GraphQLSchema | Promise<GraphQLSchema>

typeDefs?

optional typeDefs: string | string[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:24

Type definitions

typePaths?

optional typePaths: string[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:28

Paths to files that contain GraphQL definitions

useGlobalPrefix?

optional useGlobalPrefix: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:74

Prepends the global prefix to the url

See

[faq/global-prefix](Global Prefix)

---

GqlOptionsFactory

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:120

Type Parameters

Type Parameter
T extends Record<string, any>

Methods

createGqlOptions()

createGqlOptions(): Omit<T, "driver"> | Promise<Omit<T, "driver">>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:121

Returns

Omit<T, "driver"> | Promise<Omit<T, "driver">>

---

GqlSubscriptionServiceOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:14

Extends

• SubscriptionConfig

Properties

context?

optional context: 
  | GraphQLExecutionContextValue
| (ctx, id, payload, args) => GraphQLExecutionContextValue | Promise<GraphQLExecutionContextValue>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:19

execute()?

optional execute: (args) => PromiseOrValue<ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:16

Implements the "Executing requests" section of the GraphQL specification.

Returns either a synchronous ExecutionResult (if all encountered resolvers are synchronous), or a Promise of an ExecutionResult that will eventually be resolved and never rejected.

If the arguments to this function do not result in a legal execution context, a GraphQLError will be thrown immediately explaining the invalid input.

Parameters

Parameter	Type
args	ExecutionArgs

Returns

PromiseOrValue<ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>>

graphql-ws?

optional graphql-ws: 
  | boolean
  | GraphQLWsSubscriptionsConfig;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:11

Inherited from

SubscriptionConfig.graphql-ws

path?

optional path: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:18

schema

schema: GraphQLSchema;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:15

subscribe()?

optional subscribe: (args) => Promise<
  | ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>
| AsyncGenerator<ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>, void, void>>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:17

Implements the "Subscribe" algorithm described in the GraphQL specification.

Returns a Promise which resolves to either an AsyncIterator (if successful) or an ExecutionResult (error). The promise will be rejected if the schema or other arguments to this function are invalid, or if the resolved event stream is not an async iterable.

If the client-provided arguments to this function do not result in a compliant subscription, a GraphQL Response (ExecutionResult) with descriptive errors and no data will be returned.

If the source stream could not be created due to faulty subscription resolver logic or underlying systems, the promise will resolve to a single ExecutionResult containing errors and no data.

If the operation succeeded, the promise resolves to an AsyncIterator, which yields a stream of ExecutionResults representing the response stream.

Accepts either an object with named arguments, or individual arguments.

Parameters

Parameter	Type
args	ExecutionArgs

Returns

Promise< | ExecutionResult<ObjMap<unknown>, ObjMap<unknown>> | AsyncGenerator<ExecutionResult<ObjMap<unknown>, ObjMap<unknown>>, void, void>>

subscriptions-transport-ws?

optional subscriptions-transport-ws: 
  | boolean
  | GraphQLSubscriptionTransportWsConfig;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:12

Inherited from

SubscriptionConfig.subscriptions-transport-ws

---

GraphQLArgumentsHost

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:3

Extends

• ArgumentsHost

Methods

getArgByIndex()

getArgByIndex<T>(index): T;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:68

Returns a particular argument by index.

Type Parameters

Type Parameter
T

Parameters

Parameter	Type	Description
index	number	index of argument to retrieve

Returns

T

Inherited from

ArgumentsHost.getArgByIndex

getArgs()

getArgs<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:6

Returns the array of arguments being passed to the handler.

Type Parameters

Type Parameter
T

Returns

T

Overrides

ArgumentsHost.getArgs

getContext()

getContext<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:7

Type Parameters

Type Parameter
T

Returns

T

getInfo()

getInfo<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:5

Type Parameters

Type Parameter
T

Returns

T

getRoot()

getRoot<T>(): T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-arguments-host.d.ts:4

Type Parameters

Type Parameter
T

Returns

T

getType()

getType<TContext>(): TContext;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:87

Returns the current execution context type (string)

Type Parameters

Type Parameter
TContext extends string

Returns

TContext

Inherited from

ArgumentsHost.getType

switchToHttp()

switchToHttp(): HttpArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:78

Switch context to HTTP.

Returns

HttpArgumentsHost

interface with methods to retrieve HTTP arguments

Inherited from

ArgumentsHost.switchToHttp

switchToRpc()

switchToRpc(): RpcArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:73

Switch context to RPC.

Returns

RpcArgumentsHost

interface with methods to retrieve RPC arguments

Inherited from

ArgumentsHost.switchToRpc

switchToWs()

switchToWs(): WsArgumentsHost;

Defined in: node_modules/.pnpm/@nestjs+common@11.1.9/node_modules/@nestjs/common/interfaces/features/arguments-host.interface.d.ts:83

Switch context to WebSockets.

Returns

WsArgumentsHost

interface with methods to retrieve WebSockets arguments

Inherited from

ArgumentsHost.switchToWs

---

GraphQLDriver

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/graphql-driver.interface.d.ts:1

Type Parameters

Type Parameter
TOptions

Methods

start()

start(options): Promise<unknown>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/graphql-driver.interface.d.ts:2

Parameters

Parameter	Type
options	TOptions

Returns

Promise<unknown>

stop()

stop(): Promise<void>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/graphql-driver.interface.d.ts:3

Returns

Promise<void>

---

InputTypeOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/input-type.decorator.d.ts:12

Interface defining options that can be passed to @InputType() decorator.

Public Api

Properties

description?

optional description: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/input-type.decorator.d.ts:16

Description of the input type.

isAbstract?

optional isAbstract: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/input-type.decorator.d.ts:20

If true, type will not be registered in the schema.

isOneOf?

optional isOneOf: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/input-type.decorator.d.ts:25

If 'true', the input type will be '@oneOf' type. More info about '@oneOf' types in the GraphQL spec.

---

InterfaceTypeOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/interface-type.decorator.d.ts:13

Interface defining options that can be passed to @InterfaceType() decorator.

Public Api

Properties

description?

optional description: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/interface-type.decorator.d.ts:17

Description of the argument.

implements?

optional implements: Function | Function[] | () => Function | Function[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/interface-type.decorator.d.ts:29

Interfaces implemented by this interface.

isAbstract?

optional isAbstract: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/interface-type.decorator.d.ts:21

If true, type will not be registered in the schema.

resolveType?

optional resolveType: ResolveTypeFn<any, any>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/interface-type.decorator.d.ts:25

Custom implementation of the "resolveType" function.

---

MiddlewareContext

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/field-middleware.interface.d.ts:2

Type Parameters

Type Parameter
TSource
TContext
TArgs

Properties

args

args: TArgs;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/field-middleware.interface.d.ts:6

context

context: TContext;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/field-middleware.interface.d.ts:7

info

info: GraphQLResolveInfo;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/field-middleware.interface.d.ts:8

source

source: TSource;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/field-middleware.interface.d.ts:5

---

ObjectTypeOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/object-type.decorator.d.ts:12

Interface defining options that can be passed to @ObjectType() decorator

Public Api

Properties

description?

optional description: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/object-type.decorator.d.ts:16

Description of the input type.

implements?

optional implements: Function | Function[] | () => Function | Function[];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/object-type.decorator.d.ts:24

Interfaces implemented by this object type.

inheritDescription?

optional inheritDescription: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/object-type.decorator.d.ts:29

If true, direct descendant classes will inherit the parent's description if own description is not set. Also works on classes marked with isAbstract: true.

isAbstract?

optional isAbstract: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/object-type.decorator.d.ts:20

If true, type will not be registered in the schema.

---

ResolverOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolver.decorator.d.ts:8

Interface defining options that can be passed to @Resolve() decorator

Public Api

Properties

isAbstract?

optional isAbstract: boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolver.decorator.d.ts:12

If true, type will not be registered in the schema.

---

ScalarsTypeMap

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:5

Properties

scalar

scalar: GraphQLScalarType;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:7

type

type: Function;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:6

---

SchemaFileConfig

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:20

Properties

federation?

optional federation: 
  | FederationVersion
  | Federation2Config;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:26

Federation version and its configuration,

Default

1

path?

optional path: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:30

Path to the schema file.

---

UnionOptions

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/create-union-type.factory.d.ts:12

Interface defining options that can be passed to createUnionType function.

Type Parameters

Type Parameter
T extends readonly Type<unknown>[]

Properties

description?

optional description: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/create-union-type.factory.d.ts:20

Description of the union.

name?

optional name: string;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/create-union-type.factory.d.ts:16

Name of the union.

resolveType?

optional resolveType: ResolveTypeFn<any, any>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/create-union-type.factory.d.ts:24

Custom implementation of the "resolveType" function.

types()

types: () => T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/create-union-type.factory.d.ts:28

Types that the union consist of.

Returns

T

Type Aliases

ArgsOptions

type ArgsOptions<T> = BaseTypeOptions<T> & {
  deprecationReason?: string;
  description?: string;
  name?: string;
  type?: () => any;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/args.decorator.d.ts:9

Interface defining options that can be passed to @Args() decorator.

Type Declaration

deprecationReason?

optional deprecationReason: string;

Argument deprecation reason (if deprecated).

description?

optional description: string;

Description of the argument.

name?

optional name: string;

Name of the argument.

type()?

optional type: () => any;

Function that returns a reference to the arguments host class.

Returns

any

Type Parameters

Type Parameter
T

Public Api

---

ArrayElement

type ArrayElement<ArrayType> = ArrayType[number];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/create-union-type.factory.d.ts:30

Type Parameters

Type Parameter
ArrayType extends readonly unknown[]

---

AutoSchemaFileValue

type AutoSchemaFileValue = boolean | string | SchemaFileConfig;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:32

---

BaseTypeOptions

type BaseTypeOptions<T> = NonNullableBaseType<T> | NullableBaseType<T>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/base-type-options.interface.d.ts:22

Type Parameters

Type Parameter
T

---

Complexity

type Complexity = ComplexityEstimator | number;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/complexity.interface.d.ts:11

---

ComplexityEstimator()

type ComplexityEstimator = (options) => number | void;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/complexity.interface.d.ts:10

Parameters

Parameter	Type
options	ComplexityEstimatorArgs

Returns

number | void

---

ComplexityEstimatorArgs

type ComplexityEstimatorArgs = {
  args: {
   [key: string]: any;
  };
  childComplexity: number;
  field: GraphQLField<any, any>;
  type: GraphQLCompositeType;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/complexity.interface.d.ts:2

Properties

args

args: {
[key: string]: any;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/complexity.interface.d.ts:5

Index Signature

[key: string]: any

childComplexity

childComplexity: number;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/complexity.interface.d.ts:8

field

field: GraphQLField<any, any>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/complexity.interface.d.ts:4

type

type: GraphQLCompositeType;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/complexity.interface.d.ts:3

---

DateScalarMode

type DateScalarMode = "isoDate" | "timestamp";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:3

---

Enhancer

type Enhancer = "guards" | "interceptors" | "filters";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/gql-module-options.interface.d.ts:9

---

FederationConfig

type FederationConfig = Federation2Config;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:6

---

FederationVersion

type FederationVersion = 1 | 2;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/schema-file-config.interface.d.ts:5

---

FieldOptions

type FieldOptions<T> = BaseTypeOptions<T> & {
  complexity?: Complexity;
  deprecationReason?: string;
  description?: string;
  middleware?: FieldMiddleware[];
  name?: string;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/field.decorator.d.ts:15

Interface defining options that can be passed to @Field() decorator.

Type Declaration

complexity?

optional complexity: Complexity;

Field complexity options.

deprecationReason?

optional deprecationReason: string;

Field deprecation reason (if deprecated).

description?

optional description: string;

Description of the field.

middleware?

optional middleware: FieldMiddleware[];

Array of middleware to apply.

name?

optional name: string;

Name of the field.

Type Parameters

Type Parameter
T

Public Api

---

FieldType

type FieldType<T> = T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-helpers/field-type.helper.d.ts:1

Type Parameters

Type Parameter
T

---

GenerateOptions

type GenerateOptions = DefinitionsGeneratorOptions & {
  debug?: boolean;
  outputAs?: "class" | "interface";
  path: string;
  typeDefs?: string | string[];
  typePaths: string[];
  watch?: boolean;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql-definitions.factory.d.ts:3

Type Declaration

debug?

optional debug: boolean;

outputAs?

optional outputAs: "class" | "interface";

path

path: string;

typeDefs?

optional typeDefs: string | string[];

typePaths

typePaths: string[];

watch?

optional watch: boolean;

---

GqlContextType

type GqlContextType = "graphql" | ContextType;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-execution-context.d.ts:4

---

GqlTypeReference

type GqlTypeReference<T> = Type<T> | GraphQLScalarType | Function | object | symbol;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/return-type-func.interface.d.ts:3

Type Parameters

Type Parameter
T

---

GraphQLExecutionContext

type GraphQLExecutionContext = GqlExecutionContext;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-execution-context.d.ts:5

---

GraphQLSubscriptionTransportWsConfig

type GraphQLSubscriptionTransportWsConfig = Partial<Pick<SubscriptionTransportWsServerOptions, "onConnect" | "onDisconnect" | "onOperation" | "keepAlive">> & {
  path?: string;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:7

Type Declaration

path?

optional path: string;

---

GraphQLWsSubscriptionsConfig

type GraphQLWsSubscriptionsConfig = Partial<Pick<ServerOptions, 
  | "connectionInitWaitTimeout"
  | "onConnect"
  | "onDisconnect"
  | "onClose"
  | "onSubscribe"
  | "onNext">> & {
  path?: string;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:4

Type Declaration

path?

optional path: string;

---

MutationOptions

type MutationOptions<T> = BaseTypeOptions<T> & {
  complexity?: Complexity;
  deprecationReason?: string;
  description?: string;
  name?: string;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/mutation.decorator.d.ts:10

Interface defining options that can be passed to @Mutation() decorator.

Type Declaration

complexity?

optional complexity: Complexity;

Mutation complexity options.

deprecationReason?

optional deprecationReason: string;

Mutation deprecation reason (if deprecated).

description?

optional description: string;

Description of the mutation.

name?

optional name: string;

Name of the mutation.

Type Parameters

Type Parameter
T

Public Api

---

NextFn()

type NextFn<T> = () => Promise<T>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/field-middleware.interface.d.ts:10

Type Parameters

Type Parameter
T

Returns

Promise<T>

---

NullableList

type NullableList = "items" | "itemsAndList";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/base-type-options.interface.d.ts:1

---

NumberScalarMode

type NumberScalarMode = "float" | "integer";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/build-schema-options.interface.d.ts:4

---

QueryOptions

type QueryOptions<T> = BaseTypeOptions<T> & {
  complexity?: Complexity;
  deprecationReason?: string;
  description?: string;
  name?: string;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/query.decorator.d.ts:10

Interface defining options that can be passed to @Query() decorator.

Type Declaration

complexity?

optional complexity: Complexity;

Query complexity options.

deprecationReason?

optional deprecationReason: string;

Query deprecation reason (if deprecated).

description?

optional description: string;

Description of the query.

name?

optional name: string;

Name of the query.

Type Parameters

Type Parameter
T

Public Api

---

ResolveFieldOptions

type ResolveFieldOptions<T> = BaseTypeOptions<T> & {
  complexity?: Complexity;
  deprecationReason?: string;
  description?: string;
  middleware?: FieldMiddleware[];
  name?: string;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolve-field.decorator.d.ts:9

Interface defining options that can be passed to @ResolveField() decorator.

Type Declaration

complexity?

optional complexity: Complexity;

Field complexity options.

deprecationReason?

optional deprecationReason: string;

Field deprecation reason (if deprecated).

description?

optional description: string;

Description of the field.

middleware?

optional middleware: FieldMiddleware[];

Array of middleware to apply.

name?

optional name: string;

Name of the field.

Type Parameters

Type Parameter
T

Public Api

---

ResolverTypeFn()

type ResolverTypeFn = (of?) => Function;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolver.decorator.d.ts:2

Parameters

Parameter	Type
of?	void

Returns

Function

---

ResolveTypeFn()

type ResolveTypeFn<TSource, TContext> = (...args) => any;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/resolve-type-fn.interface.d.ts:2

Type Parameters

Type Parameter
TSource
TContext

Parameters

Parameter	Type
...args	Parameters<GraphQLTypeResolver<TSource, TContext>>

Returns

any

---

ReturnTypeFunc()

type ReturnTypeFunc<T> = (returns?) => T;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/return-type-func.interface.d.ts:5

Type Parameters

Type Parameter
T extends ReturnTypeFuncValue

Parameters

Parameter	Type
returns?	void

Returns

T

---

ReturnTypeFuncValue

type ReturnTypeFuncValue = 
  | GqlTypeReference
  | [GqlTypeReference];

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/interfaces/return-type-func.interface.d.ts:4

---

SubscriptionConfig

type SubscriptionConfig = {
  graphql-ws?:   | GraphQLWsSubscriptionsConfig
     | boolean;
  subscriptions-transport-ws?:   | GraphQLSubscriptionTransportWsConfig
     | boolean;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:10

Extended by

• GqlSubscriptionServiceOptions

Properties

graphql-ws?

optional graphql-ws: 
  | GraphQLWsSubscriptionsConfig
  | boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:11

subscriptions-transport-ws?

optional subscriptions-transport-ws: 
  | GraphQLSubscriptionTransportWsConfig
  | boolean;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/services/gql-subscription.service.d.ts:12

---

SubscriptionOptions

type SubscriptionOptions<T> = BaseTypeOptions<T> & {
  deprecationReason?: string;
  description?: string;
  filter?: (payload, variables, context) => boolean | Promise<boolean>;
  name?: string;
  resolve?: (payload, args, context, info) => any | Promise<any>;
};

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/subscription.decorator.d.ts:8

Interface defining options that can be passed to @Subscription() decorator.

Type Declaration

deprecationReason?

optional deprecationReason: string;

Subscription deprecation reason (if deprecated).

description?

optional description: string;

Description of the subscription.

filter()?

optional filter: (payload, variables, context) => boolean | Promise<boolean>;

Filter messages function.

Parameters

Parameter	Type
payload	any
variables	any
context	any

Returns

boolean | Promise<boolean>

name?

optional name: string;

Name of the subscription.

resolve()?

optional resolve: (payload, args, context, info) => any | Promise<any>;

Resolve messages function (to transform payload/message shape).

Parameters

Parameter	Type
payload	any
args	any
context	any
info	any

Returns

any | Promise<any>

Type Parameters

Type Parameter
T

Public Api

---

Union

type Union<T> = InstanceType<ArrayElement<T>>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/create-union-type.factory.d.ts:31

Type Parameters

Type Parameter
T extends readonly any[]

Variables

CLASS_TYPE_METADATA

const CLASS_TYPE_METADATA: "graphql:class_type" = "graphql:class_type";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:10

---

CONTEXT

const CONTEXT: "REQUEST" = "REQUEST";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/tokens.d.ts:1

---

DEFINITIONS_FILE_HEADER

const DEFINITIONS_FILE_HEADER: "\n/*\n * -------------------------------------------------------\n * THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)\n * -------------------------------------------------------\n */\n\n/* tslint:disable */\n/* eslint-disable */" = "\n/*\n * -------------------------------------------------------\n * THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)\n * -------------------------------------------------------\n */\n\n/* tslint:disable */\n/* eslint-disable */";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:17

---

FIELD_RESOLVER_MIDDLEWARE_METADATA

const FIELD_RESOLVER_MIDDLEWARE_METADATA: "graphql:field_resolver_middleware" = "graphql:field_resolver_middleware";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:4

---

FIELD_TYPENAME

const FIELD_TYPENAME: "__resolveType" = "__resolveType";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:13

---

Float

const Float: GraphQLScalarType;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/scalars/index.d.ts:4

---

GRAPHQL_MODULE_ID

const GRAPHQL_MODULE_ID: "GqlModuleId" = "GqlModuleId";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:15

---

GRAPHQL_MODULE_OPTIONS

const GRAPHQL_MODULE_OPTIONS: "GqlModuleOptions" = "GqlModuleOptions";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:14

---

GRAPHQL_SDL_FILE_END

const GRAPHQL_SDL_FILE_END: "\n" = "\n";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:19

---

GRAPHQL_SDL_FILE_HEADER

const GRAPHQL_SDL_FILE_HEADER: "# ------------------------------------------------------\n# THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)\n# ------------------------------------------------------\n\n" = "# ------------------------------------------------------\n# THIS FILE WAS AUTOMATICALLY GENERATED (DO NOT MODIFY)\n# ------------------------------------------------------\n\n";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:18

---

GraphQLISODateTime

const GraphQLISODateTime: GraphQLScalarType<Date, string>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/scalars/iso-date.scalar.d.ts:2

---

GraphQLTimestamp

const GraphQLTimestamp: GraphQLScalarType<any, number>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/scalars/timestamp.scalar.d.ts:2

---

ID

const ID: GraphQLScalarType;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/scalars/index.d.ts:5

---

Int

const Int: GraphQLScalarType;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/scalars/index.d.ts:3

---

PARAM_ARGS_METADATA

const PARAM_ARGS_METADATA: "__routeArguments__" = "__routeArguments__";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:8

---

Parent()

const Parent: () => ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/parent.decorator.d.ts:8

Resolver method parameter decorator. Extracts the parent/root object from the underlying platform and populates the decorated parameter with the value of parent/root.

Returns

ParameterDecorator

Public Api

---

RESOLVER_DELEGATE_METADATA

const RESOLVER_DELEGATE_METADATA: "graphql:delegate_property" = "graphql:delegate_property";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:5

---

RESOLVER_NAME_METADATA

const RESOLVER_NAME_METADATA: "graphql:resolver_name" = "graphql:resolver_name";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:2

---

RESOLVER_PROPERTY_METADATA

const RESOLVER_PROPERTY_METADATA: "graphql:resolve_property" = "graphql:resolve_property";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:3

---

RESOLVER_REFERENCE_KEY

const RESOLVER_REFERENCE_KEY: "__resolveReference" = "__resolveReference";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:11

---

RESOLVER_REFERENCE_METADATA

const RESOLVER_REFERENCE_METADATA: "graphql:resolve_reference" = "graphql:resolve_reference";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:12

---

RESOLVER_TYPE_METADATA

const RESOLVER_TYPE_METADATA: "graphql:resolver_type" = "graphql:resolver_type";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:1

---

Root()

const Root: () => ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/root.decorator.d.ts:8

Resolver method parameter decorator. Extracts the parent/root object from the underlying platform and populates the decorated parameter with the value of parent/root.

Returns

ParameterDecorator

Public Api

---

SCALAR_NAME_METADATA

const SCALAR_NAME_METADATA: "graphql:scalar_name" = "graphql:scalar_name";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:6

---

SCALAR_TYPE_METADATA

const SCALAR_TYPE_METADATA: "graphql:scalar_type" = "graphql:scalar_type";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:7

---

SUBSCRIPTION_OPTIONS_METADATA

const SUBSCRIPTION_OPTIONS_METADATA: "graphql:subscription_options;" = "graphql:subscription_options;";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:9

---

SUBSCRIPTION_TYPE

const SUBSCRIPTION_TYPE: "Subscription" = "Subscription";

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/graphql.constants.d.ts:16

---

TypeMetadataStorage

const TypeMetadataStorage: TypeMetadataStorageHost;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/schema-builder/storages/type-metadata.storage.d.ts:60

Functions

addFieldMetadata()

function addFieldMetadata<T>(
   typeOrOptions, 
   fieldOptions, 
   prototype, 
   propertyKey?, 
   descriptor?, 
   loadEagerly?): void;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/field.decorator.d.ts:59

Type Parameters

Type Parameter
T extends ReturnTypeFuncValue

Parameters

Parameter	Type
typeOrOptions	| ReturnTypeFunc<T> | FieldOptionsExtractor<T>
fieldOptions	FieldOptionsExtractor<T>
prototype	object
propertyKey?	string
descriptor?	TypedPropertyDescriptor<any>
loadEagerly?	boolean

Returns

void

---

Args()

Call Signature

function Args(): ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/args.decorator.d.ts:34

Resolver method parameter decorator. Extracts the arguments object from the underlying platform and populates the decorated parameter with the value of either all arguments or a single specified argument.

Returns

ParameterDecorator

Public Api

Call Signature

function Args(...pipes): ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/args.decorator.d.ts:42

Resolver method parameter decorator. Extracts the arguments object from the underlying platform and populates the decorated parameter with the value of either all arguments or a single specified argument.

Parameters

Parameter	Type
...pipes	( | PipeTransform<any, any> | Type<PipeTransform<any, any>>)[]

Returns

ParameterDecorator

Public Api

Call Signature

function Args(property, ...pipes): ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/args.decorator.d.ts:50

Resolver method parameter decorator. Extracts the arguments object from the underlying platform and populates the decorated parameter with the value of either all arguments or a single specified argument.

Parameters

Parameter	Type
property	string
...pipes	( | PipeTransform<any, any> | Type<PipeTransform<any, any>>)[]

Returns

ParameterDecorator

Public Api

Call Signature

function Args(options, ...pipes): ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/args.decorator.d.ts:58

Resolver method parameter decorator. Extracts the arguments object from the underlying platform and populates the decorated parameter with the value of either all arguments or a single specified argument.

Parameters

Parameter	Type
options	ArgsOptions
...pipes	( | PipeTransform<any, any> | Type<PipeTransform<any, any>>)[]

Returns

ParameterDecorator

Public Api

Call Signature

function Args(
   property, 
   options, ...
   pipes): ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/args.decorator.d.ts:66

Resolver method parameter decorator. Extracts the arguments object from the underlying platform and populates the decorated parameter with the value of either all arguments or a single specified argument.

Parameters

Parameter	Type
property	string
options	ArgsOptions
...pipes	( | PipeTransform<any, any> | Type<PipeTransform<any, any>>)[]

Returns

ParameterDecorator

Public Api

---

ArgsType()

function ArgsType(name?): ClassDecorator;

Defined in: packages/graphql/src/decorators/args-type.decorator.ts:11

Decorator that marks a class as a resolver arguments type.

Parameters

Parameter	Type
name?	string

Returns

ClassDecorator

Public Api

---

Context()

Call Signature

function Context(): ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/context.decorator.d.ts:10

Resolver method parameter decorator. Extracts the Context object from the underlying platform and populates the decorated parameter with the value of Context.

Returns

ParameterDecorator

Public Api

Call Signature

function Context(...pipes): ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/context.decorator.d.ts:18

Resolver method parameter decorator. Extracts the Context object from the underlying platform and populates the decorated parameter with the value of Context.

Parameters

Parameter	Type
...pipes	( | PipeTransform<any, any> | Type<PipeTransform<any, any>>)[]

Returns

ParameterDecorator

Public Api

Call Signature

function Context(property, ...pipes): ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/context.decorator.d.ts:26

Resolver method parameter decorator. Extracts the Context object from the underlying platform and populates the decorated parameter with the value of Context.

Parameters

Parameter	Type
property	string
...pipes	( | PipeTransform<any, any> | Type<PipeTransform<any, any>>)[]

Returns

ParameterDecorator

Public Api

---

createUnionType()

function createUnionType<T>(options): InstanceType<ArrayElement<T>>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/create-union-type.factory.d.ts:36

Creates a GraphQL union type composed of types references.

Type Parameters

Type Parameter
T extends readonly Type<unknown>[]

Parameters

Parameter	Type
options	UnionOptions<T>

Returns

InstanceType<ArrayElement<T>>

---

Directive()

function Directive(sdl): MethodDecorator & PropertyDecorator & ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/directive.decorator.d.ts:6

Adds a directive to specified field, type, or handler.

Parameters

Parameter	Type
sdl	string

Returns

MethodDecorator & PropertyDecorator & ClassDecorator

Public Api

---

extend()

function extend(obj1, obj2): any;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/utils/extend.util.d.ts:1

Parameters

Parameter	Type
obj1	unknown
obj2	unknown

Returns

any

---

Extensions()

function Extensions(value): MethodDecorator & ClassDecorator & PropertyDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/extensions.decorator.d.ts:6

Adds arbitrary data accessible through the "extensions" property to specified field, type, or handler.

Parameters

Parameter	Type
value	Record<string, unknown>

Returns

MethodDecorator & ClassDecorator & PropertyDecorator

Public Api

---

Field()

Call Signature

function Field(): PropertyDecorator & MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/field.decorator.d.ts:44

@Field() decorator is used to mark a specific class property as a GraphQL field. Only properties decorated with this decorator will be defined in the schema.

Returns

PropertyDecorator & MethodDecorator

Public Api

Call Signature

function Field<T>(options): PropertyDecorator & MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/field.decorator.d.ts:51

@Field() decorator is used to mark a specific class property as a GraphQL field. Only properties decorated with this decorator will be defined in the schema.

Type Parameters

Type Parameter
T extends ReturnTypeFuncValue

Parameters

Parameter	Type
options	FieldOptionsExtractor<T>

Returns

PropertyDecorator & MethodDecorator

Public Api

Call Signature

function Field<T>(returnTypeFunction?, options?): PropertyDecorator & MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/field.decorator.d.ts:58

@Field() decorator is used to mark a specific class property as a GraphQL field. Only properties decorated with this decorator will be defined in the schema.

Type Parameters

Type Parameter
T extends ReturnTypeFuncValue

Parameters

Parameter	Type
returnTypeFunction?	ReturnTypeFunc<T>
options?	FieldOptionsExtractor<T>

Returns

PropertyDecorator & MethodDecorator

Public Api

---

HideField()

function HideField(): PropertyDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/hide-field.decorator.d.ts:4

Returns

PropertyDecorator

Public Api

---

Info()

function Info(...pipes): ParameterDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/info.decorator.d.ts:10

Resolver method parameter decorator. Extracts the Info object from the underlying platform and populates the decorated parameter with the value of Info.

Parameters

Parameter	Type
...pipes	( | PipeTransform<any, any> | Type<PipeTransform<any, any>>)[]

Returns

ParameterDecorator

Public Api

---

InputType()

Call Signature

function InputType(): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/input-type.decorator.d.ts:32

Decorator that marks a class as a GraphQL input type.

Returns

ClassDecorator

Public Api

Call Signature

function InputType(options): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/input-type.decorator.d.ts:38

Decorator that marks a class as a GraphQL input type.

Parameters

Parameter	Type
options	InputTypeOptions

Returns

ClassDecorator

Public Api

Call Signature

function InputType(name, options?): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/input-type.decorator.d.ts:44

Decorator that marks a class as a GraphQL input type.

Parameters

Parameter	Type
name	string
options?	InputTypeOptions

Returns

ClassDecorator

Public Api

---

InterfaceType()

Call Signature

function InterfaceType(options?): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/interface-type.decorator.d.ts:36

Decorator that marks a class as a GraphQL interface type.

Parameters

Parameter	Type
options?	InterfaceTypeOptions

Returns

ClassDecorator

Public Api

Call Signature

function InterfaceType(name, options?): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/interface-type.decorator.d.ts:42

Decorator that marks a class as a GraphQL interface type.

Parameters

Parameter	Type
name	string
options?	InterfaceTypeOptions

Returns

ClassDecorator

Public Api

---

IntersectionType()

function IntersectionType<A, B>(
   classARef, 
   classBRef, 
decorator?): Type<A & B>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-helpers/intersection-type.helper.d.ts:3

Type Parameters

Type Parameter
A
B

Parameters

Parameter	Type
classARef	Type<A>
classBRef	Type<B>
decorator?	ClassDecoratorFactory

Returns

Type<A & B>

---

Mutation()

Call Signature

function Mutation(): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/mutation.decorator.d.ts:33

Mutation handler (method) Decorator. Routes specified mutation to this method.

Returns

MethodDecorator

Public Api

Call Signature

function Mutation(name): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/mutation.decorator.d.ts:39

Mutation handler (method) Decorator. Routes specified mutation to this method.

Parameters

Parameter	Type
name	string

Returns

MethodDecorator

Public Api

Call Signature

function Mutation(typeFunc, options?): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/mutation.decorator.d.ts:45

Mutation handler (method) Decorator. Routes specified mutation to this method.

Parameters

Parameter	Type
typeFunc	ReturnTypeFunc
options?	MutationOptions<any>

Returns

MethodDecorator

Public Api

---

ObjectType()

Call Signature

function ObjectType(): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/object-type.decorator.d.ts:36

Decorator that marks a class as a GraphQL type.

Returns

ClassDecorator

Public Api

Call Signature

function ObjectType(options): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/object-type.decorator.d.ts:42

Decorator that marks a class as a GraphQL type.

Parameters

Parameter	Type
options	ObjectTypeOptions

Returns

ClassDecorator

Public Api

Call Signature

function ObjectType(name, options?): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/object-type.decorator.d.ts:48

Decorator that marks a class as a GraphQL type.

Parameters

Parameter	Type
name	string
options?	ObjectTypeOptions

Returns

ClassDecorator

Public Api

---

OmitType()

function OmitType<T, K>(
   classRef, 
   keys, 
decorator?): Type<Omit<T, K>>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-helpers/omit-type.helper.d.ts:3

Type Parameters

Type Parameter
T
K extends string | number | symbol

Parameters

Parameter	Type
classRef	Type<T>
keys	readonly K[]
decorator?	ClassDecoratorFactory

Returns

Type<Omit<T, K>>

---

PartialType()

function PartialType<T>(classRef, optionsOrDecorator?): Type<Partial<T>>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-helpers/partial-type.helper.d.ts:8

Type Parameters

Type Parameter
T

Parameters

Parameter	Type
classRef	Type<T>
optionsOrDecorator?	ClassDecoratorFactory | PartialTypeOptions

Returns

Type<Partial<T>>

---

PickType()

function PickType<T, K>(
   classRef, 
   keys, 
decorator?): Type<Pick<T, K>>;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-helpers/pick-type.helper.d.ts:3

Type Parameters

Type Parameter
T
K extends string | number | symbol

Parameters

Parameter	Type
classRef	Type<T>
keys	readonly K[]
decorator?	ClassDecoratorFactory

Returns

Type<Pick<T, K>>

---

Plugin()

function Plugin(): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+apollo@13.2.3/node_modules/@nestjs/apollo/dist/decorators/plugin.decorator.d.ts:6

Decorator that marks a class as an Apollo plugin.

Returns

ClassDecorator

Public Api

---

Query()

Call Signature

function Query(): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/query.decorator.d.ts:33

Query handler (method) Decorator. Routes specified query to this method.

Returns

MethodDecorator

Public Api

Call Signature

function Query(name): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/query.decorator.d.ts:39

Query handler (method) Decorator. Routes specified query to this method.

Parameters

Parameter	Type
name	string

Returns

MethodDecorator

Public Api

Call Signature

function Query(typeFunc, options?): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/query.decorator.d.ts:45

Query handler (method) Decorator. Routes specified query to this method.

Parameters

Parameter	Type
typeFunc	ReturnTypeFunc
options?	QueryOptions<any>

Returns

MethodDecorator

Public Api

---

registerEnumType()

function registerEnumType<T>(enumRef, options?): void;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/type-factories/register-enum-type.factory.d.ts:29

Registers a GraphqQL enum type based on the passed enumerator reference.

Type Parameters

Type Parameter
T extends object

Parameters

Parameter	Type
enumRef	T
options?	EnumOptions<T>

Returns

void

---

ResolveField()

Call Signature

function ResolveField(typeFunc?, options?): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolve-field.decorator.d.ts:36

Field resolver (method) Decorator.

Parameters

Parameter	Type
typeFunc?	ReturnTypeFunc
options?	ResolveFieldOptions<any>

Returns

MethodDecorator

Public Api

Call Signature

function ResolveField(
   propertyName?, 
   typeFunc?, 
   options?): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolve-field.decorator.d.ts:42

Property resolver (method) Decorator.

Parameters

Parameter	Type
propertyName?	string
typeFunc?	ReturnTypeFunc
options?	ResolveFieldOptions<any>

Returns

MethodDecorator

Public Api

---

ResolveProperty()

Call Signature

function ResolveProperty(typeFunc?, options?): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolve-property.decorator.d.ts:8

Property resolver (method) Decorator.

Parameters

Parameter	Type
typeFunc?	ReturnTypeFunc
options?	ResolveFieldOptions

Returns

MethodDecorator

Public Api

Call Signature

function ResolveProperty(
   propertyName?, 
   typeFunc?, 
   options?): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolve-property.decorator.d.ts:14

Property resolver (method) Decorator.

Parameters

Parameter	Type
propertyName?	string
typeFunc?	ReturnTypeFunc
options?	ResolveFieldOptions

Returns

MethodDecorator

Public Api

---

Resolver()

Call Signature

function Resolver(): MethodDecorator & ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolver.decorator.d.ts:19

Object resolver decorator.

Returns

MethodDecorator & ClassDecorator

Public Api

Call Signature

function Resolver(name): MethodDecorator & ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolver.decorator.d.ts:25

Object resolver decorator.

Parameters

Parameter	Type
name	string

Returns

MethodDecorator & ClassDecorator

Public Api

Call Signature

function Resolver(options): MethodDecorator & ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolver.decorator.d.ts:31

Object resolver decorator.

Parameters

Parameter	Type
options	ResolverOptions

Returns

MethodDecorator & ClassDecorator

Public Api

Call Signature

function Resolver(classType, options?): MethodDecorator & ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolver.decorator.d.ts:37

Object resolver decorator.

Parameters

Parameter	Type
classType	Function
options?	ResolverOptions

Returns

MethodDecorator & ClassDecorator

Public Api

Call Signature

function Resolver(typeFunc, options?): MethodDecorator & ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolver.decorator.d.ts:43

Object resolver decorator.

Parameters

Parameter	Type
typeFunc	ResolverTypeFn
options?	ResolverOptions

Returns

MethodDecorator & ClassDecorator

Public Api

---

ResolveReference()

function ResolveReference(): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/resolve-reference.decorator.d.ts:6

Property reference resolver (method) Decorator.

Returns

MethodDecorator

Public Api

---

Scalar()

Call Signature

function Scalar(name): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/scalar.decorator.d.ts:7

Decorator that marks a class as a GraphQL scalar.

Parameters

Parameter	Type
name	string

Returns

ClassDecorator

Public Api

Call Signature

function Scalar(name, typeFunc): ClassDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/scalar.decorator.d.ts:13

Decorator that marks a class as a GraphQL scalar.

Parameters

Parameter	Type
name	string
typeFunc	ReturnTypeFunc

Returns

ClassDecorator

Public Api

---

Subscription()

Call Signature

function Subscription(): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/subscription.decorator.d.ts:35

Subscription handler (method) Decorator. Routes subscriptions to this method.

Returns

MethodDecorator

Public Api

Call Signature

function Subscription(name): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/subscription.decorator.d.ts:41

Subscription handler (method) Decorator. Routes subscriptions to this method.

Parameters

Parameter	Type
name	string

Returns

MethodDecorator

Public Api

Call Signature

function Subscription(name, options): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/subscription.decorator.d.ts:47

Subscription handler (method) Decorator. Routes subscriptions to this method.

Parameters

Parameter	Type
name	string
options	Pick<SubscriptionOptions, "filter" | "resolve">

Returns

MethodDecorator

Public Api

Call Signature

function Subscription(typeFunc, options?): MethodDecorator;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/decorators/subscription.decorator.d.ts:53

Subscription handler (method) Decorator. Routes subscriptions to this method.

Parameters

Parameter	Type
typeFunc	ReturnTypeFunc
options?	SubscriptionOptions<any>

Returns

MethodDecorator

Public Api

---

transformSchema()

function transformSchema(schema, transformType): GraphQLSchema;

Defined in: node_modules/.pnpm/@nestjs+graphql@13.2.3/node_modules/@nestjs/graphql/dist/utils/transform-schema.util.d.ts:24

Parameters

Parameter	Type
schema	GraphQLSchema
transformType	TypeTransformer

Returns

GraphQLSchema