Class MercuriusFederationDriver

Public Api

Hierarchy (View Summary)

AbstractGraphQLDriver<MercuriusDriverConfig>
- MercuriusFederationDriver

Index

Constructors

constructor

new MercuriusFederationDriver(
graphqlFederationFactory: GraphQLFederationFactory,
): MercuriusFederationDriver
Parameters
- graphqlFederationFactory: GraphQLFederationFactory
Returns MercuriusFederationDriver
Overrides AbstractGraphQLDriver.constructor
- 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-federation.driver.d.ts:11

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-federation.driver.d.ts:12

Methods

generateSchema

generateSchema(options: MercuriusDriverConfig): Promise<GraphQLSchema>
Parameters
- options: MercuriusDriverConfig
Returns Promise<GraphQLSchema>
Overrides AbstractGraphQLDriver.generateSchema
- 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-federation.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,
defaults?: Record<string, any>,
): Promise<MercuriusDriverConfig>
Parameters
- options: MercuriusDriverConfig
- Optionaldefaults: Record<string, any>
Returns Promise<MercuriusDriverConfig>
Inherited from AbstractGraphQLDriver.mergeDefaultOptions
- 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

start

start(options: MercuriusDriverConfig): Promise<void>
Parameters
- options: 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-federation.driver.d.ts:13

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-federation.driver.d.ts:14

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
Inherited from AbstractGraphQLDriver.subscriptionWithFilter
- 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 MercuriusFederationDriver

Public Api

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MercuriusFederationDriver

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>

`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 MercuriusFederationDriver

Public Api

Hierarchy (View Summary)

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns MercuriusFederationDriver

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>

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