GraphQLgraphql/error
graphql/error モジュールは、GraphQLエラーの作成とフォーマットを担当します。 graphql/error モジュール、またはルートの graphql モジュールからインポートできます。例えば
import { GraphQLError } from "graphql" // ES6var { GraphQLError } = require("graphql") // CommonJS
概要#
エラー#
GraphQLError#
class GraphQLError extends Error { constructor( message: string, nodes?: Array<any>, stack?: ?string, source?: Source, positions?: Array<number>, originalError?: ?Error, extensions?: ?{ [key: string]: mixed } )}
GraphQL内で発生したエラーの表現。デバッグのために、エラーが発生したクエリ内の場所に関する情報が含まれています。 ほとんどの場合、後述の locatedError で構築されます。
syntaxError#
function syntaxError( source: Source, position: number, description: string): GraphQLError;
構文エラーを表す GraphQLError を生成します。ソース内の構文エラーの位置に関する有用な記述情報が含まれています。
locatedError#
function locatedError(error: ?Error, nodes: Array<any>): GraphQLError {
GraphQL操作の実行中にスローされたと思われる任意のエラーが与えられた場合、元のエラーの原因となったドキュメント内の場所を認識する新しい GraphQLError を生成します。
formatError#
function formatError(error: GraphQLError): GraphQLFormattedError
type GraphQLFormattedError = { message: string, locations: ?Array<GraphQLErrorLocation>};
type GraphQLErrorLocation = { line: number, column: number};
GraphQLError が与えられた場合、GraphQL仕様のレスポンスフォーマットのエラーセクションで記述されたルールに従ってフォーマットします。