UNPKG

2.24 kBTypeScriptView Raw
1import { DocumentNode, GraphQLError } from 'graphql';
2import { RequestAgent } from 'apollo-server-env';
3import { Logger, GraphQLRequestContextDidResolveOperation, GraphQLRequestContextDidEncounterErrors } from 'apollo-server-types';
4import { ApolloServerPluginUsageReportingOptions, VariableValueOptions, SendValuesBaseOptions, GenerateClientInfo } from './options';
5import { ApolloServerPlugin } from 'apollo-server-plugin-base';
6export interface EngineReportingOptions<TContext> {
7 apiKey?: string;
8 calculateSignature?: (ast: DocumentNode, operationName: string) => string;
9 reportIntervalMs?: number;
10 maxUncompressedReportSize?: number;
11 endpointUrl?: string;
12 tracesEndpointUrl?: string;
13 debugPrintReports?: boolean;
14 requestAgent?: RequestAgent | false;
15 maxAttempts?: number;
16 minimumRetryDelayMs?: number;
17 reportErrorFunction?: (err: Error) => void;
18 sendVariableValues?: VariableValueOptions;
19 reportTiming?: ReportTimingOptions<TContext>;
20 privateVariables?: Array<String> | boolean;
21 sendHeaders?: SendValuesBaseOptions;
22 privateHeaders?: Array<String> | boolean;
23 handleSignals?: boolean;
24 sendReportsImmediately?: boolean;
25 maskErrorDetails?: boolean;
26 rewriteError?: (err: GraphQLError) => GraphQLError | null;
27 schemaTag?: string;
28 graphVariant?: string;
29 generateClientInfo?: GenerateClientInfo<TContext>;
30 reportSchema?: boolean;
31 overrideReportedSchema?: string;
32 schemaReportingInitialDelayMaxMs?: number;
33 schemaReportingUrl?: string;
34 logger?: Logger;
35 experimental_schemaReporting?: boolean;
36 experimental_overrideReportedSchema?: string;
37 experimental_schemaReportingInitialDelayMaxMs?: number;
38}
39export declare type ReportTimingOptions<TContext> = ((request: GraphQLRequestContextDidResolveOperation<TContext> | GraphQLRequestContextDidEncounterErrors<TContext>) => Promise<boolean>) | boolean;
40export declare function ApolloServerPluginUsageReportingFromLegacyOptions<TContext>(options?: EngineReportingOptions<TContext>): ApolloServerPlugin;
41export declare function legacyOptionsToPluginOptions(engine: EngineReportingOptions<any>): ApolloServerPluginUsageReportingOptions<any>;
42//# sourceMappingURL=legacyOptions.d.ts.map
\No newline at end of file