📣 GraphQL Conf 2023 • 9 月 19-21 日 • 旧金山 • 观看视频！

graphql/utilities

graphql/utilities 模块包含与 GraphQL 语言和类型对象一起使用的常见有用计算。您可以从 graphql/utilities 模块或根 graphql 模块导入。例如

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

概述#

内省

```
var introspectionQuery
```
包含足够信息以重现类型系统的 GraphQL 内省查询。
```
function buildClientSchema
```
使用 `introspectionQuery` 查询模式的结果生成客户端模式。

模式语言

```
function buildSchema
```
从 GraphQL 模式语言构建模式对象。
```
function printSchema
```
以标准格式打印模式。
```
function printIntrospectionSchema
```
以标准格式打印模式的内省功能。
```
function buildASTSchema
```
从解析的 AST 模式构建模式。
```
function typeFromAST
```
在 GraphQLSchema 中查找 AST 中引用的类型。
```
function astFromValue
```
根据 JavaScript 值生成 GraphQL 输入值 AST。

访问者

```
class TypeInfo
```
在访问者 AST 遍历期间跟踪类型和字段定义。

值验证

```
function isValidJSValue
```
确定 JavaScript 值是否对 GraphQL 类型有效。
```
function isValidLiteralValue
```
确定 AST 中的文字值是否对 GraphQL 类型有效。

内省#

introspectionQuery#

var introspectionQuery: string

一个 GraphQL 查询，它查询服务器的内省系统以获取足够的信息来重现该服务器的类型系统。

buildClientSchema#

function buildClientSchema(
  introspection: IntrospectionQuery
): GraphQLSchema

构建供客户端工具使用的 GraphQLSchema。

给定客户端运行内省查询的结果，创建并返回一个 GraphQLSchema 实例，该实例可用于所有 GraphQL.js 工具，但不能用于执行查询，因为内省不代表“解析器”、“解析”或“序列化”函数或任何其他服务器内部机制。

模式表示#

buildSchema#

function buildSchema(source: string | Source): GraphQLSchema {

从 GraphQL 模式语言创建 GraphQLSchema 对象。该模式将使用默认解析器。有关 GraphQL 模式语言的更多详细信息，请参阅模式语言文档或此模式语言速查表。

printSchema#

function printSchema(schema: GraphQLSchema): string {

以模式语言格式打印提供的模式。

printIntrospectionSchema#

function printIntrospectionSchema(schema: GraphQLSchema): string {

以模式语言格式打印内置内省模式。

buildASTSchema#

function buildASTSchema(
  ast: SchemaDocument,
  queryTypeName: string,
  mutationTypeName: ?string
): GraphQLSchema

这将采用由 graphql/language/schema 中的 parseSchemaIntoAST 生成的模式文档的 ast，并构建一个 GraphQLSchema 实例，该实例可用于所有 GraphQL.js 工具，但不能用于执行查询，因为内省不代表“解析器”、“解析”或“序列化”函数或任何其他服务器内部机制。

typeFromAST#

function typeFromAST(
  schema: GraphQLSchema,
  inputTypeAST: Type
): ?GraphQLType

给定类型在 GraphQL AST 中出现的名称和模式，从该模式返回相应的 GraphQLType。

astFromValue#

function astFromValue(
  value: any,
  type: GraphQLInputType
): ?Value

根据 JavaScript 值生成 GraphQL 输入值 AST。

可选地，可以提供 GraphQL 类型，这将用于区分值基元。

访问者#

TypeInfo#

class TypeInfo {
  constructor(schema: GraphQLSchema)
  getType(): ?GraphQLOutputType {
  getParentType(): ?GraphQLCompositeType {
  getInputType(): ?GraphQLInputType {
  getFieldDef(): ?GraphQLFieldDefinition {
  getDirective(): ?GraphQLDirective {
  getArgument(): ?GraphQLArgument {
}

TypeInfo 是一个实用程序类，它在给定 GraphQL 模式的情况下，可以通过调用 enter(node) 和 leave(node) 来跟踪 GraphQL 文档 AST 中任何点的当前字段和类型定义。

值验证#

isValidJSValue#

function isValidJSValue(value: any, type: GraphQLInputType): string[]

给定一个 JavaScript 值和一个 GraphQL 类型，确定该值是否会被该类型接受。这主要用于验证查询变量的运行时值。

isValidLiteralValue#

function isValidLiteralValue(
  type: GraphQLInputType,
  valueAST: Value
): string[]

用于验证器的实用程序，它确定给定输入类型，值文字 AST 是否有效。

请注意，这仅验证文字值，变量被假定为提供正确类型的值。