@graphql-inspector/core
Version:
Tooling for GraphQL. Compare GraphQL Schemas, check documents, find breaking changes, find similar types.
31 lines (30 loc) • 1.52 kB
text/typescript
import { GraphQLObjectType, GraphQLUnionType } from 'graphql';
import { Change, ChangeType, CriticalityLevel, UnionMemberAddedChange, UnionMemberRemovedChange } from './change.cjs';
export declare function unionMemberRemovedFromMeta(args: UnionMemberRemovedChange): {
readonly criticality: {
readonly level: CriticalityLevel.Breaking;
readonly reason: "Removing a union member from a union can cause existing queries that use this union member in a fragment spread to error.";
};
readonly type: "UNION_MEMBER_REMOVED";
readonly message: string;
readonly meta: {
unionName: string;
removedUnionMemberTypeName: string;
};
readonly path: string;
};
export declare function unionMemberRemoved(union: GraphQLUnionType, type: GraphQLObjectType): Change<typeof ChangeType.UnionMemberRemoved>;
export declare function buildUnionMemberAddedMessageFromMeta(args: UnionMemberAddedChange): {
readonly criticality: {
readonly level: CriticalityLevel.Dangerous;
readonly reason: "Adding a possible type to Unions may break existing clients that were not programming defensively against a new possible type.";
};
readonly type: "UNION_MEMBER_ADDED";
readonly message: string;
readonly meta: {
unionName: string;
addedUnionMemberTypeName: string;
};
readonly path: string;
};
export declare function unionMemberAdded(union: GraphQLUnionType, type: GraphQLObjectType): Change<typeof ChangeType.UnionMemberAdded>;