mirror of
https://github.com/vale981/apollo-server
synced 2025-03-15 15:26:40 -04:00
990d915aec
* remove formatParams * remove formatParams from documentation * check for valid query string after persisted query mapping * fix sentence about different logging and label extensions as experimental * mark graphql-extensions as more experimental
74 lines
2.3 KiB
TypeScript
74 lines
2.3 KiB
TypeScript
import {
|
|
GraphQLSchema,
|
|
ValidationContext,
|
|
GraphQLFieldResolver,
|
|
} from 'graphql';
|
|
import { GraphQLExtension } from 'graphql-extensions';
|
|
import { CacheControlExtensionOptions } from 'apollo-cache-control';
|
|
import { KeyValueCache } from 'apollo-server-caching';
|
|
import { DataSource } from 'apollo-datasource';
|
|
|
|
/*
|
|
* GraphQLServerOptions
|
|
*
|
|
* - schema: an executable GraphQL schema used to fulfill requests.
|
|
* - (optional) formatError: Formatting function applied to all errors before response is sent
|
|
* - (optional) rootValue: rootValue passed to GraphQL execution
|
|
* - (optional) context: the context passed to GraphQL execution
|
|
* - (optional) validationRules: extra validation rules applied to requests
|
|
* - (optional) formatResponse: a function applied to each graphQL execution result
|
|
* - (optional) fieldResolver: a custom default field resolver
|
|
* - (optional) debug: a boolean that will print additional debug logging if execution errors occur
|
|
* - (optional) extensions: an array of functions which create GraphQLExtensions (each GraphQLExtension object is used for one request)
|
|
*
|
|
*/
|
|
export interface GraphQLServerOptions<
|
|
TContext =
|
|
| (() => Promise<Record<string, any>> | Record<string, any>)
|
|
| Record<string, any>
|
|
> {
|
|
schema: GraphQLSchema;
|
|
formatError?: Function;
|
|
rootValue?: any;
|
|
context?: TContext;
|
|
validationRules?: Array<(context: ValidationContext) => any>;
|
|
formatResponse?: Function;
|
|
fieldResolver?: GraphQLFieldResolver<any, TContext>;
|
|
debug?: boolean;
|
|
tracing?: boolean;
|
|
cacheControl?:
|
|
| boolean
|
|
| (CacheControlExtensionOptions & {
|
|
calculateHttpHeaders?: boolean;
|
|
stripFormattedExtensions?: boolean;
|
|
});
|
|
extensions?: Array<() => GraphQLExtension>;
|
|
dataSources?: () => DataSources<TContext>;
|
|
cache?: KeyValueCache;
|
|
persistedQueries?: PersistedQueryOptions;
|
|
}
|
|
|
|
export type DataSources<TContext> = {
|
|
[name: string]: DataSource<TContext>;
|
|
};
|
|
|
|
export interface PersistedQueryOptions {
|
|
cache: KeyValueCache;
|
|
}
|
|
|
|
export default GraphQLServerOptions;
|
|
|
|
export async function resolveGraphqlOptions(
|
|
options:
|
|
| GraphQLServerOptions
|
|
| ((
|
|
...args: Array<any>
|
|
) => Promise<GraphQLServerOptions> | GraphQLServerOptions),
|
|
...args: Array<any>
|
|
): Promise<GraphQLServerOptions> {
|
|
if (typeof options === 'function') {
|
|
return await options(...args);
|
|
} else {
|
|
return options;
|
|
}
|
|
}
|