Class: GraphQLModule

Defined in: packages/apollo/src/graphql.module.ts:61

GraphQL module for nestelia backed by Apollo Server. Provides static and async configuration methods.

Example

GraphQLModule.forRoot({
  path: "/graphql",
  autoSchemaFile: true,
  playground: true,
})

Implements

• OnModuleDestroy

Constructors

Constructor

new GraphQLModule(): GraphQLModule;

Returns

GraphQLModule

Methods

onModuleDestroy()

onModuleDestroy(): void;

Defined in: packages/apollo/src/graphql.module.ts:62

Returns

void

Implementation of

OnModuleDestroy.onModuleDestroy

---

forRoot()

static forRoot(options): DynamicModule;

Defined in: packages/apollo/src/graphql.module.ts:91

Configures GraphQL with static options. The Apollo Server is started eagerly during module bootstrap.

Parameters

Parameter	Type	Description
options	ApolloOptions	GraphQL configuration options.

Returns

DynamicModule

Dynamic module configuration.

Example

import { ElysiaFactory } from 'nestelia';

const app = await ElysiaFactory.create(AppModule);

@Module({
  imports: [
    GraphQLModule.forRoot({
      path: '/graphql',
      autoSchemaFile: true,
      playground: true,
    })
  ]
})
class AppModule {}

---

forRootAsync()

static forRootAsync(options): DynamicModule;

Defined in: packages/apollo/src/graphql.module.ts:140

Configures GraphQL with async options resolved from the DI container.

Parameters

Parameter	Type	Description
options	{ inject?: ProviderToken[]; useFactory: (...args) => | ApolloOptions<unknown> | Promise<ApolloOptions<unknown>>; }	Async configuration options.
options.inject?	ProviderToken[]	-
options.useFactory	(...args) => | ApolloOptions<unknown> | Promise<ApolloOptions<unknown>>	-

Returns

DynamicModule

Dynamic module configuration.

Example

GraphQLModule.forRootAsync({
  useFactory: async (configService: ConfigService) => ({
    path: '/graphql',
    autoSchemaFile: true,
    playground: configService.get('NODE_ENV') !== 'production',
  }),
  inject: [ConfigService],
})