Alternative approach for findSchemaChanges

graphql · Oct 14, 2024 · d4a1114 · d4a1114
1 parent 0254e5f
commit d4a1114
Show file tree

Hide file tree

Showing 3 changed files with 7 additions and 1 deletion.
diff --git a/src/index.ts b/src/index.ts
@@ -474,6 +474,7 @@ export {
   DangerousChangeType,
   findBreakingChanges,
   findDangerousChanges,
+  findSchemaChanges,
 } from './utilities/index.js';
 
 export type {

diff --git a/src/utilities/findBreakingChanges.ts b/src/utilities/findBreakingChanges.ts
@@ -78,6 +78,8 @@ export interface DangerousChange {
 /**
  * Given two schemas, returns an Array containing descriptions of all the types
  * of breaking changes covered by the other functions down below.
+ *
+ * @deprecated Please use `findSchemaChanges` instead. Will be removed in v18.
  */
 export function findBreakingChanges(
   oldSchema: GraphQLSchema,
@@ -92,6 +94,8 @@ export function findBreakingChanges(
 /**
  * Given two schemas, returns an Array containing descriptions of all the types
  * of potentially dangerous changes covered by the other functions down below.
+ *
+ * @deprecated Please use `findSchemaChanges` instead. Will be removed in v18.
  */
 export function findDangerousChanges(
   oldSchema: GraphQLSchema,
@@ -103,7 +107,7 @@ export function findDangerousChanges(
   );
 }
 
-function findSchemaChanges(
+export function findSchemaChanges(
   oldSchema: GraphQLSchema,
   newSchema: GraphQLSchema,
 ): Array<BreakingChange | DangerousChange> {

diff --git a/src/utilities/index.ts b/src/utilities/index.ts
@@ -106,6 +106,7 @@ export {
   DangerousChangeType,
   findBreakingChanges,
   findDangerousChanges,
+  findSchemaChanges,
 } from './findBreakingChanges.js';
 export type { BreakingChange, DangerousChange } from './findBreakingChanges.js';