Class MercuriusDriver

Public Api

Hierarchy (View Summary)

AbstractGraphQLDriver<MercuriusDriverConfig>
- MercuriusDriver

Index

Constructors

constructor

new MercuriusDriver(): MercuriusDriver
Returns MercuriusDriver
Inherited from AbstractGraphQLDriver.constructor

Properties

`Protected` `Optional` `Readonly`applicationConfig

applicationConfig?: ApplicationConfig

`Protected` `Readonly`graphQlFactory

graphQlFactory: GraphQLFactory

`Protected` `Readonly`httpAdapterHost

httpAdapterHost: HttpAdapterHost

Accessors

instance

get instance(): FastifyInstance<
    Server<typeof IncomingMessage, typeof ServerResponse>,
    IncomingMessage,
    ServerResponse<IncomingMessage>,
    FastifyBaseLogger,
>
Returns FastifyInstance<
    Server<typeof IncomingMessage, typeof ServerResponse>,
    IncomingMessage,
    ServerResponse<IncomingMessage>,
    FastifyBaseLogger,
>
- Defined in node_modules/.pnpm/@nestjs+mercurius@13.2.5_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15._gj37yqxgimhaq2it25ftob7lya/node_modules/@nestjs/mercurius/dist/drivers/mercurius.driver.d.ts:9

Methods

generateSchema

generateSchema(options: MercuriusDriverConfig): Promise<GraphQLSchema> | null
Parameters
- options: MercuriusDriverConfig
Returns Promise<GraphQLSchema> | null
Inherited from AbstractGraphQLDriver.generateSchema
- 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: MercuriusDriverConfig): string
Parameters
- options: MercuriusDriverConfig
Returns string
Inherited from AbstractGraphQLDriver.getNormalizedPath
- 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: MercuriusDriverConfig,
): Promise<MercuriusDriverConfig>
Parameters
- options: MercuriusDriverConfig
Returns Promise<MercuriusDriverConfig>
Overrides AbstractGraphQLDriver.mergeDefaultOptions
- Defined in node_modules/.pnpm/@nestjs+mercurius@13.2.5_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15._gj37yqxgimhaq2it25ftob7lya/node_modules/@nestjs/mercurius/dist/drivers/mercurius.driver.d.ts:12

start

start(mercuriusOptions: MercuriusDriverConfig): Promise<void>
Parameters
- mercuriusOptions: MercuriusDriverConfig
Returns Promise<void>
Overrides AbstractGraphQLDriver.start
- Defined in node_modules/.pnpm/@nestjs+mercurius@13.2.5_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15._gj37yqxgimhaq2it25ftob7lya/node_modules/@nestjs/mercurius/dist/drivers/mercurius.driver.d.ts:10

stop

stop(): Promise<void>
Returns Promise<void>
Overrides AbstractGraphQLDriver.stop
- Defined in node_modules/.pnpm/@nestjs+mercurius@13.2.5_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15._gj37yqxgimhaq2it25ftob7lya/node_modules/@nestjs/mercurius/dist/drivers/mercurius.driver.d.ts:11

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
Overrides AbstractGraphQLDriver.subscriptionWithFilter
- Defined in node_modules/.pnpm/@nestjs+mercurius@13.2.5_@nestjs+common@11.1.17_class-transformer@0.5.1_class-validator@0.15._gj37yqxgimhaq2it25ftob7lya/node_modules/@nestjs/mercurius/dist/drivers/mercurius.driver.d.ts:13

Class MercuriusDriver

Public Api

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MercuriusDriver

Properties

`Protected` `Optional` `Readonly`applicationConfig

`Protected` `Readonly`graphQlFactory

`Protected` `Readonly`httpAdapterHost

Accessors

instance

Returns FastifyInstance<
    Server<typeof IncomingMessage, typeof ServerResponse>,
    IncomingMessage,
    ServerResponse<IncomingMessage>,
    FastifyBaseLogger,
>

Methods

generateSchema

Parameters

Returns Promise<GraphQLSchema> | null

`Protected`getNormalizedPath

Parameters

Returns string

mergeDefaultOptions

Parameters

Returns Promise<MercuriusDriverConfig>

start

Parameters

Returns Promise<void>

stop

Returns Promise<void>

subscriptionWithFilter

Parameters

Returns any

Settings

On This Page

Class MercuriusDriver

Public Api

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Returns MercuriusDriver

Properties

Protected Optional ReadonlyapplicationConfig

Protected ReadonlygraphQlFactory

Protected ReadonlyhttpAdapterHost

Accessors

instance

Returns FastifyInstance< Server<typeof IncomingMessage, typeof ServerResponse>, IncomingMessage, ServerResponse<IncomingMessage>, FastifyBaseLogger,>

Methods

generateSchema

Parameters

Returns Promise<GraphQLSchema> | null

ProtectedgetNormalizedPath

Parameters

Returns string

mergeDefaultOptions

Parameters

Returns Promise<MercuriusDriverConfig>

start

Parameters

Returns Promise<void>

stop

Returns Promise<void>

subscriptionWithFilter

Parameters

Returns any

Settings

On This Page

`Protected` `Optional` `Readonly`applicationConfig

`Protected` `Readonly`graphQlFactory

`Protected` `Readonly`httpAdapterHost

Returns FastifyInstance<
Server<typeof IncomingMessage, typeof ServerResponse>,
IncomingMessage,
ServerResponse<IncomingMessage>,
FastifyBaseLogger,
>

`Protected`getNormalizedPath