extendSchema.d.ts 1.2 KB

12345678910111213141516171819202122232425262728293031323334353637383940
  1. import type { DocumentNode } from '../language/ast';
  2. import type {
  3. GraphQLSchemaNormalizedConfig,
  4. GraphQLSchemaValidationOptions,
  5. } from '../type/schema';
  6. import { GraphQLSchema } from '../type/schema';
  7. interface Options extends GraphQLSchemaValidationOptions {
  8. /**
  9. * Set to true to assume the SDL is valid.
  10. *
  11. * Default: false
  12. */
  13. assumeValidSDL?: boolean;
  14. }
  15. /**
  16. * Produces a new schema given an existing schema and a document which may
  17. * contain GraphQL type extensions and definitions. The original schema will
  18. * remain unaltered.
  19. *
  20. * Because a schema represents a graph of references, a schema cannot be
  21. * extended without effectively making an entire copy. We do not know until it's
  22. * too late if subgraphs remain unchanged.
  23. *
  24. * This algorithm copies the provided schema, applying extensions while
  25. * producing the copy. The original schema remains unaltered.
  26. */
  27. export declare function extendSchema(
  28. schema: GraphQLSchema,
  29. documentAST: DocumentNode,
  30. options?: Options,
  31. ): GraphQLSchema;
  32. /**
  33. * @internal
  34. */
  35. export declare function extendSchemaImpl(
  36. schemaConfig: GraphQLSchemaNormalizedConfig,
  37. documentAST: DocumentNode,
  38. options?: Options,
  39. ): GraphQLSchemaNormalizedConfig;
  40. export {};