@proto-kit/api • Docs
Documentation / @proto-kit/api / GraphqlServer
Class: GraphqlServer
Lifecycle of a SequencerModule
start(): Executed to execute any logic required to start the module
Extends
Constructors
new GraphqlServer()
new GraphqlServer():
GraphqlServer
Returns
Inherited from
Properties
currentConfig
protectedcurrentConfig:undefined|GraphqlServerOptions
Store the config separately, so that we can apply additional checks when retrieving it via the getter
Inherited from
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:17
presets
staticpresets:Presets<unknown>
Inherited from
Defined in
packages/sequencer/dist/sequencer/builder/SequencerModule.d.ts:8
Accessors
config
Get Signature
get config():
Config
Returns
Config
Set Signature
set config(
config):void
Parameters
• config: Config
Returns
void
Inherited from
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:18
Methods
close()
close():
Promise<void>
Returns
Promise<void>
Defined in
packages/api/src/graphql/GraphqlServer.ts:149
create()
create(
childContainerProvider):void
Parameters
• childContainerProvider: ChildContainerProvider
Returns
void
Inherited from
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:20
registerModule()
registerModule(
module):void
Parameters
• module: TypedClass<GraphqlModule<unknown>>
Returns
void
Defined in
packages/api/src/graphql/GraphqlServer.ts:56
registerResolvers()
registerResolvers(
resolvers):void
Parameters
• resolvers: NonEmptyArray<Function>
Returns
void
Defined in
packages/api/src/graphql/GraphqlServer.ts:64
registerSchema()
registerSchema(
schema):void
Parameters
• schema: GraphQLSchema
Returns
void
Defined in
packages/api/src/graphql/GraphqlServer.ts:60
setContainer()
setContainer(
container):void
Parameters
• container: DependencyContainer
Returns
void
Defined in
packages/api/src/graphql/GraphqlServer.ts:44
setContext()
setContext(
context):void
Parameters
• context
Returns
void
Defined in
packages/api/src/graphql/GraphqlServer.ts:72
start()
start():
Promise<void>
Start the module and all it’s functionality. The returned Promise has to resolve after initialization, since it will block in the sequencer init. That means that you mustn’t await server.start() for example.
Returns
Promise<void>
Overrides
Defined in
packages/api/src/graphql/GraphqlServer.ts:76
startServer()
startServer():
Promise<void>
Returns
Promise<void>