@graphql-tools/merge
Version:
A set of utils for faster development of GraphQL tools
87 lines (86 loc) • 2.76 kB
text/typescript
import { DefinitionNode, DocumentNode, ParseOptions } from 'graphql';
import { GetDocumentNodeFromSchemaOptions, TypeSource } from '@graphql-tools/utils';
import { OnFieldTypeConflict } from './fields.cjs';
import { CompareFn } from './utils.cjs';
type Omit<T, K extends keyof any> = Pick<T, Exclude<keyof T, K>>;
export interface Config extends ParseOptions, GetDocumentNodeFromSchemaOptions {
/**
* Produces `schema { query: ..., mutation: ..., subscription: ... }`
*
* Default: true
*/
useSchemaDefinition?: boolean;
/**
* Creates schema definition, even when no types are available
* Produces: `schema { query: Query }`
*
* Default: false
*/
forceSchemaDefinition?: boolean;
/**
* Throws an error on a merge conflict
*
* Default: false
*/
throwOnConflict?: boolean;
/**
* Descriptions are defined as preceding string literals, however an older
* experimental version of the SDL supported preceding comments as
* descriptions. Set to true to enable this deprecated behavior.
* This option is provided to ease adoption and will be removed in v16.
*
* Default: false
*/
commentDescriptions?: boolean;
/**
* Puts the next directive first.
*
* Default: false
*
* @example:
* Given:
* ```graphql
* type User { a: String @foo }
* type User { a: String @bar }
* ```
*
* Results:
* ```
* type User { a: @bar @foo }
* ```
*/
reverseDirectives?: boolean;
exclusions?: string[];
sort?: boolean | CompareFn<string>;
convertExtensions?: boolean;
consistentEnumMerge?: boolean;
ignoreFieldConflicts?: boolean;
/**
* Called if types of the same fields are different
*
* Default: false
*
* @example:
* Given:
* ```graphql
* type User { a: String }
* type User { a: Int }
* ```
*
* Instead of throwing `already defined with a different type` error,
* `onFieldTypeConflict` function is called.
*/
onFieldTypeConflict?: OnFieldTypeConflict;
reverseArguments?: boolean;
}
/**
* Merges multiple type definitions into a single `DocumentNode`
* @param types The type definitions to be merged
*/
export declare function mergeTypeDefs(typeSource: TypeSource): DocumentNode;
export declare function mergeTypeDefs(typeSource: TypeSource, config?: Partial<Config> & {
commentDescriptions: true;
}): string;
export declare function mergeTypeDefs(typeSource: TypeSource, config?: Omit<Partial<Config>, 'commentDescriptions'>): DocumentNode;
export declare function mergeGraphQLTypes(typeSource: TypeSource, config: Config): DefinitionNode[];
export {};