@proto-kit/api • Docs
Documentation / @proto-kit/api / QueryGraphqlModule
Class: QueryGraphqlModule<RuntimeModules>
Used by various module sub-types that may need to be configured
Extends
Type Parameters
• RuntimeModules extends RuntimeModulesRecord
Constructors
new QueryGraphqlModule()
new QueryGraphqlModule<
RuntimeModules>(queryTransportModule,networkStateTransportModule,runtime,protocol,blockStorage):QueryGraphqlModule<RuntimeModules>
Parameters
• queryTransportModule: QueryTransportModule
• networkStateTransportModule: NetworkStateTransportModule
• runtime: Runtime<RuntimeModules>
• protocol: Protocol<MandatoryProtocolModulesRecord & ProtocolModulesRecord>
• blockStorage: BlockStorage
Returns
QueryGraphqlModule<RuntimeModules>
Overrides
SchemaGeneratingGraphqlModule.constructor
Defined in
packages/api/src/graphql/modules/QueryGraphqlModule.ts:71
Properties
currentConfig
protectedcurrentConfig:undefined|NoConfig
Store the config separately, so that we can apply additional checks when retrieving it via the getter
Inherited from
SchemaGeneratingGraphqlModule.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
SchemaGeneratingGraphqlModule.config
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:18
Methods
create()
create(
childContainerProvider):void
Parameters
• childContainerProvider: ChildContainerProvider
Returns
void
Inherited from
SchemaGeneratingGraphqlModule.create
Defined in
packages/common/dist/config/ConfigurableModule.d.ts:20
generateSchema()
generateSchema():
GraphQLSchema
Returns
GraphQLSchema
Overrides
SchemaGeneratingGraphqlModule.generateSchema
Defined in
packages/api/src/graphql/modules/QueryGraphqlModule.ts:360
generateSchemaForQuery()
generateSchemaForQuery<
ModuleType,ContainerModulesRecord>(container,containerQuery,namePrefix):ObjMap<GraphQLFieldConfig<unknown,unknown,any>>
Type Parameters
• ModuleType extends BaseModuleType
• ContainerModulesRecord extends ModulesRecord<BaseModuleType>
Parameters
• container: ModuleContainer<ContainerModulesRecord, NoConfig>
• containerQuery: Query<ModuleType, any>
• namePrefix: string
Returns
ObjMap<GraphQLFieldConfig<unknown, unknown, any>>
Defined in
packages/api/src/graphql/modules/QueryGraphqlModule.ts:309
generateStateMapResolver()
generateStateMapResolver<
Key,Value>(fieldKey,query,stateMap):GraphQLFieldConfig<unknown,unknown,any>
Type Parameters
• Key
• Value
Parameters
• fieldKey: string
• query: QueryGetterStateMap<Key, Value>
• stateMap: StateMap<Key, Value>
Returns
GraphQLFieldConfig<unknown, unknown, any>
Defined in
packages/api/src/graphql/modules/QueryGraphqlModule.ts:221
generateStateResolver()
generateStateResolver<
Value>(fieldKey,query,state):object
Type Parameters
• Value
Parameters
• fieldKey: string
• query: QueryGetterState<Value>
• state: State<Value>
Returns
object
args
args:
object={}
resolve()
resolve: () =>
Promise<any>
Returns
Promise<any>
type
type:
GraphQLScalarType<unknown,unknown> |GraphQLObjectType<any,any> =valueType
Defined in
packages/api/src/graphql/modules/QueryGraphqlModule.ts:275
state()
state(
path):Promise<undefined|string[]>
Parameters
• path: string
Returns
Promise<undefined | string[]>