abstract class AbstractGraphQLDriver<TOptions extends Record<string, any> = GqlModuleOptions> implements GraphQLDriver {
protected httpAdapterHost: HttpAdapterHost
protected applicationConfig?: ApplicationConfig
protected graphQlFactory: GraphQLFactory
abstract start(options: TOptions): Promise<unknown>
abstract stop(): Promise<void>
mergeDefaultOptions(options: TOptions, defaults: Record<string, any> = {...}): Promise<TOptions>
generateSchema(options: TOptions): Promise<GraphQLSchema> | null
subscriptionWithFilter(instanceRef: unknown, filterFn: (payload: any, variables: any, context: any) => boolean | Promise<boolean>, createSubscribeContext: Function)
protected getNormalizedPath(options: TOptions): string
}
Methods
start()
|
|---|
abstract start(options: TOptions): Promise<unknown>
Parameters
| Option |
Type |
Description |
options
|
TOptions |
|
Returns
Promise<unknown>
|
stop()
|
|---|
abstract stop(): Promise<void>
Parameters
There are no parameters.
Returns
Promise<void>
|
mergeDefaultOptions()
|
|---|
mergeDefaultOptions(options: TOptions, defaults: Record<string, any> = {
path: '/graphql',
fieldResolverEnhancers: []
}): Promise<TOptions>
Parameters
| Option |
Type |
Description |
options
|
TOptions |
|
defaults
|
Record |
Optional. Default is `{
path: '/graphql',
fieldResolverEnhancers: []
}`.
|
Returns
Promise<TOptions>
|
generateSchema()
|
|---|
generateSchema(options: TOptions): Promise<GraphQLSchema> | null
Parameters
| Option |
Type |
Description |
options
|
TOptions |
|
Returns
Promise<GraphQLSchema> | null
|
subscriptionWithFilter()
|
|---|
subscriptionWithFilter(instanceRef: unknown, filterFn: (payload: any, variables: any, context: any) => boolean | Promise<boolean>, createSubscribeContext: Function)
Parameters
| Option |
Type |
Description |
instanceRef
|
unknown |
|
filterFn
|
(payload: any, variables: any, context: any) => boolean | Promise |
|
createSubscribeContext
|
Function |
|
|
getNormalizedPath()
|
|---|
protected getNormalizedPath(options: TOptions): string
Parameters
| Option |
Type |
Description |
options
|
TOptions |
|
Returns
string
|
