Update documentation on deprecated formatError(..) (#3512)

dwelch2344 · web-flow · commit 15040d02eb3c · 2022-04-07T14:59:15.000-04:00
diff --git a/src/error/GraphQLError.ts b/src/error/GraphQLError.ts
@@ -290,7 +290,7 @@ export function printError(error: GraphQLError): string {
  * Given a GraphQLError, format it according to the rules described by the
  * Response Format, Errors section of the GraphQL Specification.
  *
- * @deprecated Please use `error.toString` instead. Will be removed in v17
+ * @deprecated Please use `error.toJSON` instead. Will be removed in v17
  */
 export function formatError(error: GraphQLError): GraphQLFormattedError {
   return error.toJSON();

Original file line number	Diff line number	Diff line change
`@@ -290,7 +290,7 @@ export function printError(error: GraphQLError): string {`
`290`	`290`	`* Given a GraphQLError, format it according to the rules described by the`
`291`	`291`	`* Response Format, Errors section of the GraphQL Specification.`
`292`	`292`	`*`
`293`		- * @deprecated Please use `error.toString` instead. Will be removed in v17
	`293`	+ * @deprecated Please use `error.toJSON` instead. Will be removed in v17
`294`	`294`	`*/`
`295`	`295`	`export function formatError(error: GraphQLError): GraphQLFormattedError {`
`296`	`296`	`return error.toJSON();`