Class AbstractGraphQLDriver<TOptions>`Abstract`

Public Api

Type Parameters

TOptions extends Record<string, any> = GqlModuleOptions

Hierarchy (View Summary)

AbstractGraphQLDriver

Implements

GraphQLDriver<TOptions>

Index

Constructors

constructor

new AbstractGraphQLDriver<
TOptions extends Record<string, any> = GqlModuleOptions<any>,
>(): AbstractGraphQLDriver<TOptions>
Type Parameters
- TOptions extends Record<string, any> = GqlModuleOptions<any>
Returns AbstractGraphQLDriver<TOptions>

Properties

`Protected` `Optional` `Readonly`applicationConfig

applicationConfig?: ApplicationConfig

`Protected` `Readonly`graphQlFactory

graphQlFactory: GraphQLFactory

`Protected` `Readonly`httpAdapterHost

httpAdapterHost: HttpAdapterHost

Methods

generateSchema

generateSchema(options: TOptions): Promise<GraphQLSchema> | null
Parameters
- options: TOptions
Returns Promise<GraphQLSchema> | null
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:15

`Protected`getNormalizedPath

getNormalizedPath(options: TOptions): string
Parameters
- options: TOptions
Returns string
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:17

mergeDefaultOptions

mergeDefaultOptions(
options: TOptions,
defaults?: Record<string, any>,
): Promise<TOptions>
Parameters
- options: TOptions
- Optionaldefaults: Record<string, any>
Returns Promise<TOptions>
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:14

`Abstract`start

start(options: TOptions): Promise<unknown>
Parameters
- options: TOptions
Returns Promise<unknown>
Implementation of GraphQLDriver.start
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:12

`Abstract`stop

stop(): Promise<void>
Returns Promise<void>
Implementation of GraphQLDriver.stop
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:13

subscriptionWithFilter

subscriptionWithFilter(
    instanceRef: unknown,
    filterFn: (
        payload: any,
        variables: any,
        context: any,
    ) => boolean | Promise<boolean>,
    createSubscribeContext: Function,
): any
Parameters
- instanceRef: unknown
- filterFn: (payload: any, variables: any, context: any) => boolean | Promise<boolean>
- createSubscribeContext: Function
Returns any
- Defined in node_modules/.pnpm/@nestjs+graphql@13.2.5_@fastify+websocket@11.2.0_@nestjs+common@11.1.17_class-transformer@0.5_4lhm67ifxrywknepqup2jyrlja/node_modules/@nestjs/graphql/dist/drivers/abstract-graphql.driver.d.ts:16

Class AbstractGraphQLDriver<TOptions>`Abstract`

Public Api

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns AbstractGraphQLDriver<TOptions>

Properties

`Protected` `Optional` `Readonly`applicationConfig

`Protected` `Readonly`graphQlFactory

`Protected` `Readonly`httpAdapterHost

Methods

generateSchema

Parameters

Returns Promise<GraphQLSchema> | null

`Protected`getNormalizedPath

Parameters

Returns string

mergeDefaultOptions

Parameters

Returns Promise<TOptions>

`Abstract`start

Parameters

Returns Promise<unknown>

`Abstract`stop

Returns Promise<void>

subscriptionWithFilter

Parameters

Returns any

Settings

On This Page

Class AbstractGraphQLDriver<TOptions>Abstract

Public Api

Type Parameters

Hierarchy (View Summary)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

Returns AbstractGraphQLDriver<TOptions>

Properties

Protected Optional ReadonlyapplicationConfig

Protected ReadonlygraphQlFactory

Protected ReadonlyhttpAdapterHost

Methods

generateSchema

Parameters

Returns Promise<GraphQLSchema> | null

ProtectedgetNormalizedPath

Parameters

Returns string

mergeDefaultOptions

Parameters

Returns Promise<TOptions>

Abstractstart

Parameters

Returns Promise<unknown>

Abstractstop

Returns Promise<void>

subscriptionWithFilter

Parameters

Returns any

Settings

On This Page

Class AbstractGraphQLDriver<TOptions>`Abstract`

`Protected` `Optional` `Readonly`applicationConfig

`Protected` `Readonly`graphQlFactory

`Protected` `Readonly`httpAdapterHost

`Protected`getNormalizedPath

`Abstract`start

`Abstract`stop