@proto-kit/api • Docs

Documentation / @proto-kit/api / SchemaGeneratingGraphqlModule

Class: abstract SchemaGeneratingGraphqlModule<Config>

Used by various module sub-types that may need to be configured

Extends

• GraphqlModule<Config>

Extended by

• QueryGraphqlModule

Type Parameters

• Config = NoConfig

Constructors

new SchemaGeneratingGraphqlModule()

new SchemaGeneratingGraphqlModule<Config>(): SchemaGeneratingGraphqlModule<Config>

Returns

SchemaGeneratingGraphqlModule<Config>

Inherited from

GraphqlModule.constructor

Defined in

packages/api/src/graphql/GraphqlModule.ts:11

Properties

currentConfig

protected currentConfig: undefined | Config

Store the config separately, so that we can apply additional checks when retrieving it via the getter

Inherited from

GraphqlModule.currentConfig

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:17

Accessors

config

Get Signature

get config(): Config

Returns

Config

Set Signature

set config(config): void

Parameters

• config: Config

Returns

void

Inherited from

GraphqlModule.config

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:18

Methods

create()

create(childContainerProvider): void

Parameters

• childContainerProvider: ChildContainerProvider

Returns

void

Inherited from

GraphqlModule.create

Defined in

packages/common/dist/config/ConfigurableModule.d.ts:20

generateSchema()

abstract generateSchema(): GraphQLSchema

Returns

GraphQLSchema

Defined in

packages/api/src/graphql/GraphqlModule.ts:27