Class ApolloGatewayDriver

Public Api

Hierarchy

ApolloBaseDriver<ApolloGatewayDriverConfig>
- ApolloGatewayDriver

Index

Constructors

constructor

new ApolloGatewayDriver(modulesContainer: ModulesContainer): ApolloGatewayDriver
Parameters
- modulesContainer: ModulesContainer
Returns ApolloGatewayDriver
Overrides ApolloBaseDriver<ApolloGatewayDriverConfig>.constructor
- Defined in node_modules/.pnpm/@nestjs+apollo@13.2.5_@apollo+server@5.5.0_graphql@16.13.2__@as-integrations+express5@1.1.2_@_7gxuysmbojla2lfm53qrihi7eu/node_modules/@nestjs/apollo/dist/drivers/apollo-gateway.driver.d.ts:9

Properties

`Protected`apolloServer

apolloServer: ApolloServer<BaseContext>

`Protected` `Optional` `Readonly`applicationConfig

applicationConfig?: ApplicationConfig

`Protected` `Readonly`graphQlFactory

graphQlFactory: GraphQLFactory

`Protected` `Readonly`httpAdapterHost

httpAdapterHost: HttpAdapterHost

Accessors

instance

get instance(): ApolloServer<BaseContext>
Returns ApolloServer<BaseContext>
Inherited from ApolloBaseDriver.instance
- Defined in node_modules/.pnpm/@nestjs+apollo@13.2.5_@apollo+server@5.5.0_graphql@16.13.2__@as-integrations+express5@1.1.2_@_7gxuysmbojla2lfm53qrihi7eu/node_modules/@nestjs/apollo/dist/drivers/apollo-base.driver.d.ts:6

Methods

generateSchema

generateSchema(_: ApolloGatewayDriverConfig): any
Parameters
- _: ApolloGatewayDriverConfig
Returns any
Overrides ApolloBaseDriver.generateSchema
- Defined in node_modules/.pnpm/@nestjs+apollo@13.2.5_@apollo+server@5.5.0_graphql@16.13.2__@as-integrations+express5@1.1.2_@_7gxuysmbojla2lfm53qrihi7eu/node_modules/@nestjs/apollo/dist/drivers/apollo-gateway.driver.d.ts:12

`Protected`getNormalizedPath

getNormalizedPath(options: ApolloGatewayDriverConfig): string
Parameters
- options: ApolloGatewayDriverConfig
Returns string
Inherited from ApolloBaseDriver.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: Record<string, any>): Promise<Record<string, any>>
Parameters
- options: Record<string, any>
Returns Promise<Record<string, any>>
Overrides ApolloBaseDriver.mergeDefaultOptions
- Defined in node_modules/.pnpm/@nestjs+apollo@13.2.5_@apollo+server@5.5.0_graphql@16.13.2__@as-integrations+express5@1.1.2_@_7gxuysmbojla2lfm53qrihi7eu/node_modules/@nestjs/apollo/dist/drivers/apollo-gateway.driver.d.ts:11

`Protected`registerExpress

registerExpress(
options: ApolloGatewayDriverConfig,
__namedParameters?: { preStartHook?: () => void },
): Promise<void>
Parameters
- options: ApolloGatewayDriverConfig
- Optional__namedParameters: { preStartHook?: () => void }
Returns Promise<void>
Inherited from ApolloBaseDriver.registerExpress
- Defined in node_modules/.pnpm/@nestjs+apollo@13.2.5_@apollo+server@5.5.0_graphql@16.13.2__@as-integrations+express5@1.1.2_@_7gxuysmbojla2lfm53qrihi7eu/node_modules/@nestjs/apollo/dist/drivers/apollo-base.driver.d.ts:11

`Protected`registerFastify

registerFastify(
options: ApolloGatewayDriverConfig,
__namedParameters?: { preStartHook?: () => void },
): Promise<void>
Parameters
- options: ApolloGatewayDriverConfig
- Optional__namedParameters: { preStartHook?: () => void }
Returns Promise<void>
Inherited from ApolloBaseDriver.registerFastify
- Defined in node_modules/.pnpm/@nestjs+apollo@13.2.5_@apollo+server@5.5.0_graphql@16.13.2__@as-integrations+express5@1.1.2_@_7gxuysmbojla2lfm53qrihi7eu/node_modules/@nestjs/apollo/dist/drivers/apollo-base.driver.d.ts:14

start

start(options: ApolloGatewayDriverConfig): Promise<void>
Parameters
- options: ApolloGatewayDriverConfig
Returns Promise<void>
Overrides ApolloBaseDriver.start
- Defined in node_modules/.pnpm/@nestjs+apollo@13.2.5_@apollo+server@5.5.0_graphql@16.13.2__@as-integrations+express5@1.1.2_@_7gxuysmbojla2lfm53qrihi7eu/node_modules/@nestjs/apollo/dist/drivers/apollo-gateway.driver.d.ts:10

stop

stop(): Promise<void>
Returns Promise<void>
Inherited from ApolloBaseDriver.stop
- Defined in node_modules/.pnpm/@nestjs+apollo@13.2.5_@apollo+server@5.5.0_graphql@16.13.2__@as-integrations+express5@1.1.2_@_7gxuysmbojla2lfm53qrihi7eu/node_modules/@nestjs/apollo/dist/drivers/apollo-base.driver.d.ts:8

subscriptionWithFilter

subscriptionWithFilter(
    instanceRef: unknown,
    filterFn: (
        payload: any,
        variables: any,
        context: any,
    ) => boolean | Promise<boolean>,
    createSubscribeContext: Function,
): <TPayload, TVariables, TContext, TInfo>(
    ...args: [TPayload, TVariables, TContext, TInfo],
) => any
Parameters
- instanceRef: unknown
- filterFn: (payload: any, variables: any, context: any) => boolean | Promise<boolean>
- createSubscribeContext: Function
Returns <TPayload, TVariables, TContext, TInfo>(
...args: [TPayload, TVariables, TContext, TInfo],
) => any
Inherited from ApolloBaseDriver.subscriptionWithFilter
- Defined in node_modules/.pnpm/@nestjs+apollo@13.2.5_@apollo+server@5.5.0_graphql@16.13.2__@as-integrations+express5@1.1.2_@_7gxuysmbojla2lfm53qrihi7eu/node_modules/@nestjs/apollo/dist/drivers/apollo-base.driver.d.ts:10

Class ApolloGatewayDriver

Public Api

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Returns ApolloGatewayDriver

Properties

ProtectedapolloServer

Protected Optional ReadonlyapplicationConfig

Protected ReadonlygraphQlFactory

Protected ReadonlyhttpAdapterHost

Accessors

instance

Returns ApolloServer<BaseContext>

Methods

generateSchema

Parameters

Returns any

ProtectedgetNormalizedPath

Parameters

Returns string

mergeDefaultOptions

Parameters

Returns Promise<Record<string, any>>

ProtectedregisterExpress

Parameters

Returns Promise<void>

ProtectedregisterFastify

Parameters

Returns Promise<void>

start

Parameters

Returns Promise<void>

stop

Returns Promise<void>

subscriptionWithFilter

Parameters

Returns <TPayload, TVariables, TContext, TInfo>( ...args: [TPayload, TVariables, TContext, TInfo],) => any

Settings

On This Page

`Protected`apolloServer

`Protected` `Optional` `Readonly`applicationConfig

`Protected` `Readonly`graphQlFactory

`Protected` `Readonly`httpAdapterHost

`Protected`getNormalizedPath

`Protected`registerExpress

`Protected`registerFastify

Returns <TPayload, TVariables, TContext, TInfo>(
...args: [TPayload, TVariables, TContext, TInfo],
) => any