GraphQL LogoGraphQL

graphql/validation

graphql/validation 模組會執行 GraphQL 結果的驗證階段。您可以從 graphql/validation 模組或根 graphql 模組匯入。例如

import { validate } from "graphql/validation" // ES6
var { validate } = require("graphql/validation") // CommonJS

概觀#

驗證#

驗證#

function validate(
schema: GraphQLSchema,
ast: Document,
rules?: Array<any>
): Array<GraphQLError>

實作規格中的「驗證」區段。

驗證同步執行,傳回遇到的錯誤陣列,或是在未遇到錯誤且文件有效的狀況下傳回空陣列。

可以提供特定驗證規則清單。如果未提供,則會使用 GraphQL 規格定義的預設規則清單。

每個驗證規則都是傳回訪客的函式(請參閱語言/訪客 API)。預期訪客方法會傳回 GraphQLErrors,或是在無效時傳回 GraphQLErrors 陣列。

訪客也可以提供 visitSpreadFragments: true,這會變更訪客的行為,略過頂層定義的片段,而是在遇到每個擴散時拜訪這些片段。

specifiedRules#

var specifiedRules: Array<(context: ValidationContext): any>

此組包含 GraphQL 規格定義的所有驗證規則