diff --git a/website/pages/api-v16/language.mdx b/website/pages/api-v16/language.mdx
index 342bfe023b..29b2097e43 100644
--- a/website/pages/api-v16/language.mdx
+++ b/website/pages/api-v16/language.mdx
@@ -1040,7 +1040,7 @@ token; // => { kind: '{', value: undefined, line: 1, column: 1 }
Name node identifying this AST node. |
- | variableDefinitions? |
+ variableDefinitions? |
|
Deprecated variable definitions declared by this legacy fragment
definition. This legacy fragment variable syntax will be removed in v17.
@@ -2997,9 +2997,9 @@ complete experimental fragment-arguments feature. |
Types:
- DirectiveLocationEnum
+ DirectiveLocationEnum
·
- KindEnum
+ KindEnum
@@ -3431,7 +3431,7 @@ complete experimental fragment-arguments feature.
### Types
-#### DirectiveLocationEnum Deprecated
+#### DirectiveLocationEnum
**Type alias.** Deprecated legacy alias for the enum type representing directive location
values. This alias will be removed in v17. In v17, [`DirectiveLocation`](/api-v16/language#directivelocation) is
@@ -3442,7 +3442,7 @@ corresponding TypeScript type.
-#### KindEnum Deprecated
+#### KindEnum
**Type alias.** Deprecated legacy alias for the enum type representing the possible kind
values of AST nodes. This alias will be removed in v17. In v17, [`Kind`](/api-v16/language#kind) is
@@ -3464,7 +3464,7 @@ corresponding TypeScript type.
Types:
- TokenKindEnum
+ TokenKindEnum
@@ -3778,7 +3778,7 @@ lexer emits.
### Types
-#### TokenKindEnum Deprecated
+#### TokenKindEnum
**Type alias.** Deprecated legacy alias for the enum type representing token kind values.
This alias will be removed in v17. In v17, [`TokenKind`](/api-v16/language#tokenkind) is exported as the
@@ -4566,7 +4566,7 @@ CPU time and memory.
To prevent this you can set a maximum number of tokens allowed within a document.
- | allowLegacyFragmentVariables? |
+ allowLegacyFragmentVariables? |
|
Deprecated option that allows legacy fragment variable definitions to be
parsed. This legacy fragment variable syntax will be removed in v17. Move
@@ -5418,11 +5418,13 @@ text; // => '{\n hero {\n name\n }\n}'
### Functions
+#### visit()
+
+
+
+Overload 1
+
+visit() will walk through an AST using a depth-first traversal, calling
+the visitor's enter function at each node in the traversal, and calling the
+leave function after visiting that node and all of its child nodes.
+
+By returning different values from the enter and leave functions, the
+behavior of the visitor can be altered, including skipping over a sub-tree of
+the AST (by returning false), editing the AST by returning a value or null
+to remove the value, or to stop the whole traversal by returning BREAK.
+
+When using visit() to edit an AST, the original AST will not be modified, and
+a new version of the AST with the changes applied will be returned from the
+visit function.
+
+
+
+Type Parameters
+
+
+
+
+ | Name |
+ Constraint |
+ Default |
+ Description |
+
+
+
+
+ | N |
+ |
+ |
+ The root AST node type returned when visiting without reducing. |
+
+
+
+
+**Signature:**
+
+
+
+
+
+Arguments
+
+
+
+
+ | Name |
+ Type |
+ Default |
+ Description |
+
+
+
+
+ | root |
+ |
+ |
+ The AST node at which to start traversal. |
+
+
+ | visitor |
+ |
+ |
+ The visitor or reducer functions to call while traversing. |
+
+
+ | visitorKeys? |
+ |
+ |
+ Optional map of child keys to visit for each AST node kind. |
+
+
+
+
+
+
+Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The original AST, an edited AST, or a reduced value depending on the visitor. |
+
+
+
+
+
+
+Example 1
+
+```ts
+// Return values control traversal: undefined makes no change, false skips
+// a subtree, BREAK stops traversal, null removes a node, and any other
+// value replaces the current node.
+import { Kind, parse, print, visit } from 'graphql/language';
+
+const document = parse('{ hero { name } }');
+const editedAST = visit(document, {
+ Field: (node) => {
+ if (node.name.value === 'hero') {
+ return {
+ ...node,
+ name: { kind: Kind.NAME, value: 'human' },
+ };
+ }
+ },
+});
+
+print(editedAST); // => '{\n human {\n name\n }\n}'
+```
+
+
+
+Example 2
+
+```ts
+// A named visitor function runs when entering nodes of that kind.
+import { parse, visit } from 'graphql/language';
+
+const document = parse('{ hero { name } }');
+const fieldNames = [];
+
+visit(document, {
+ Field: (node) => {
+ fieldNames.push(node.name.value);
+ },
+});
+
+fieldNames; // => ['hero', 'name']
+```
+
+
+
+Example 3
+
+```ts
+// A named visitor object can provide separate enter and leave handlers for
+// nodes of that kind.
+import { parse, visit } from 'graphql/language';
+
+const document = parse('{ hero { name } }');
+const events = [];
+
+visit(document, {
+ Field: {
+ enter: (node) => {
+ events.push(`enter:${node.name.value}`);
+ },
+ leave: (node) => {
+ events.push(`leave:${node.name.value}`);
+ },
+ },
+});
+
+events; // => ['enter:hero', 'enter:name', 'leave:name', 'leave:hero']
+```
+
+
+
+Example 4
+
+```ts
+// Generic enter and leave handlers run for every node.
+import { parse, visit } from 'graphql/language';
+
+const document = parse('{ hero { name } }');
+let enterCount = 0;
+let leaveCount = 0;
+
+visit(document, {
+ enter: (node) => {
+ enterCount += 1;
+ },
+ leave: (node) => {
+ leaveCount += 1;
+ },
+});
+
+enterCount; // => leaveCount
+enterCount > 0; // => true
+```
+
+
+
+Overload 2
+
+Traverses an AST with reducer callbacks and returns the reduced value.
+
+
+
+Type Parameters
+
+
+
+
+ | Name |
+ Constraint |
+ Default |
+ Description |
+
+
+
+
+ | R |
+ |
+ |
+ The value produced by reducer visitor callbacks. |
+
+
+
+
+**Signature:**
+
+
+
+
+
+Arguments
+
+
+
+
+ | Name |
+ Type |
+ Default |
+ Description |
+
+
+
+
+ | root |
+ |
+ |
+ The AST node where traversal starts. |
+
+
+ | visitor |
+ |
+ |
+ Reducer callbacks to invoke during traversal. |
+
+
+ | visitorKeys? |
+ |
+ |
+ Optional mapping of child keys for each AST node kind. |
+
+
+
+
+
+
+Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The value produced by the reducer visitor. |
+
+
+
+
+
+
+Example
+
+```ts
+// A reducer visitor returns values from leave handlers to build a reduced
+// result instead of returning an edited AST.
+import { parse, visit } from 'graphql/language';
+
+const document = parse('{ hero { name } }');
+const printed = visit(document, {
+ Name: {
+ leave: (node) => {
+ return node.value;
+ },
+ },
+ Field: {
+ leave: (node) => {
+ return node.selectionSet == null
+ ? node.name
+ : `${node.name} { ${node.selectionSet} }`;
+ },
+ },
+ SelectionSet: {
+ leave: (node) => {
+ return node.selections.join(' ');
+ },
+ },
+ OperationDefinition: {
+ leave: (node) => {
+ return node.selectionSet;
+ },
+ },
+ Document: {
+ leave: (node) => {
+ return node.definitions.join('\n');
+ },
+ },
+});
+
+printed; // => 'hero { name }'
+```
+
+
+
#### visitInParallel()
Creates a new visitor instance which delegates to many visitors to run in
@@ -5582,7 +5912,7 @@ handlers.leave; // => undefined
-#### getVisitFn() Deprecated
+#### getVisitFn()
Given a visitor instance, if it is leaving or not, and a node kind, return
the function the visitor runtime should call. This deprecated compatibility
@@ -5710,7 +6040,7 @@ A value that can be returned from a visitor function to stop traversal.
-#### ASTVisitorKeyMap Deprecated
+#### ASTVisitorKeyMap
**Type alias.** Deprecated visitor key map type retained for compatibility. Inline this
mapped type at use sites because ASTVisitorKeyMap will be removed in v17.
diff --git a/website/pages/api-v16/subscription.mdx b/website/pages/api-v16/subscription.mdx
index fa8476ae76..69c068cb13 100644
--- a/website/pages/api-v16/subscription.mdx
+++ b/website/pages/api-v16/subscription.mdx
@@ -1,4 +1,6 @@
-import { ApiSignature } from '../../components/ApiCode';
+import { ApiSignature, ApiType } from '../../components/ApiCode';
+
+# graphql/subscription
NOTE: the `graphql/subscription` module has been deprecated with its
exported functions integrated into the `graphql/execution` module, to
@@ -11,15 +13,442 @@ module. In v17, the `graphql/subscription` module will be dropped entirely.
These exports are also available from the root `graphql` package.
+## Functions
+
+### subscribe()
+
+Implements the "Subscribe" algorithm described in the GraphQL specification.
+
+Returns a Promise that resolves to either an AsyncIterator (if successful)
+or an ExecutionResult (error). The promise will be rejected if the schema or
+other arguments to this function are invalid, or if the resolved event stream
+is not an async iterable.
+
+If the client-provided arguments to this function do not result in a
+compliant subscription, a GraphQL Response (ExecutionResult) with
+descriptive errors and no data will be returned.
+
+If the source stream could not be created due to faulty subscription
+resolver logic or underlying systems, the promise will resolve to a single
+ExecutionResult containing `errors` and no `data`.
+
+If the operation succeeded, the promise resolves to an AsyncIterator, which
+yields a stream of ExecutionResults representing the response stream.
+
+Each payload yielded by the source event stream is executed with the payload
+as the root value. This maps the subscription source stream into the response
+stream described by the GraphQL specification.
+
+Accepts an object with named arguments.
+
+**Signature:**
+
+
+
+
+
+Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | args |
+ |
+ The arguments used to perform the operation. |
+
+
+
+
+
+
+Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ A source stream mapped to execution results, or an execution result
+containing subscription errors. |
+
+
+
+
+
+
+Example 1
+
+```ts
+// Use a same-named rootValue function to provide the source event stream.
+import assert from 'node:assert';
+import { parse } from 'graphql/language';
+import { buildSchema } from 'graphql/utilities';
+import { subscribe } from 'graphql/execution';
+
+async function* greetings() {
+ yield { greeting: 'Hello' };
+ yield { greeting: 'Bonjour' };
+}
+
+const schema = buildSchema(`
+ type Query {
+ noop: String
+ }
+
+ type Subscription {
+ greeting: String
+ }
+`);
+
+const result = await subscribe({
+ schema,
+ document: parse('subscription { greeting }'),
+ rootValue: { greeting: () => greetings() },
+});
+
+assert('next' in result);
+
+const firstPayload = await result.next();
+firstPayload.value; // => { data: { greeting: 'Hello' } }
+```
+
+
+
+Example 2
+
+```ts
+// This variant supplies events through a custom subscribeFieldResolver.
+import assert from 'node:assert';
+import { parse } from 'graphql/language';
+import { buildSchema } from 'graphql/utilities';
+import { subscribe } from 'graphql/execution';
+
+async function* defaultGreetings() {
+ yield { greeting: 'Hello' };
+}
+
+async function* frenchGreetings() {
+ yield { greeting: 'Bonjour' };
+}
+
+const schema = buildSchema(`
+ type Query {
+ noop: String
+ }
+
+ type Subscription {
+ greeting(locale: String): String
+ }
+`);
+
+const result = await subscribe({
+ schema,
+ document: parse(
+ 'subscription Greeting($locale: String) { greeting(locale: $locale) }',
+ ),
+ rootValue: {
+ greeting: (args, contextValue) => {
+ const locale = args.locale ?? contextValue.defaultLocale;
+ return locale === 'fr' ? frenchGreetings() : defaultGreetings();
+ },
+ },
+ contextValue: { defaultLocale: 'fr' },
+ variableValues: { locale: 'fr' },
+ operationName: 'Greeting',
+ subscribeFieldResolver: (rootValue, args, contextValue, info) => {
+ args.locale; // => 'fr'
+ return rootValue[info.fieldName](args, contextValue);
+ },
+});
+
+assert('next' in result);
+
+const firstPayload = await result.next();
+firstPayload.value; // => { data: { greeting: 'Bonjour' } }
+```
+
+
+
+Example 3
+
+```ts
+// This variant shows the error result when the schema has no subscription root.
+import assert from 'node:assert';
+import { parse } from 'graphql/language';
+import { buildSchema } from 'graphql/utilities';
+import { subscribe } from 'graphql/execution';
+
+const schema = buildSchema(`
+ type Query {
+ noop: String
+ }
+`);
+
+const result = await subscribe({
+ schema,
+ document: parse('subscription { greeting }'),
+});
+
+assert('errors' in result);
+
+result.errors[0].message; // => 'Schema is not configured to execute subscription operation.'
+```
+
+
+
+### createSourceEventStream()
+
+
+
+Overload 1
+
+Implements the "CreateSourceEventStream" algorithm described in the
+GraphQL specification, resolving the subscription source event stream.
+
+Returns a Promise that resolves to either an AsyncIterable (if successful)
+or an ExecutionResult (error). The promise will be rejected if the schema or
+other arguments to this function are invalid, or if the resolved event stream
+is not an async iterable.
+
+If the client-provided arguments to this function do not result in a
+compliant subscription, a GraphQL Response (ExecutionResult) with
+descriptive errors and no data will be returned.
+
+If the source stream could not be created due to faulty subscription
+resolver logic or underlying systems, the promise will resolve to a single
+ExecutionResult containing `errors` and no `data`.
+
+If the operation succeeded, the promise resolves to the AsyncIterable for the
+event stream returned by the resolver.
+
+A Source Event Stream represents a sequence of events, each of which triggers
+a GraphQL execution for that event.
+
+This may be useful when hosting the stateful subscription service in a
+different process or machine than the stateless GraphQL execution engine,
+or otherwise separating these two steps. For more on this, see the
+"Supporting Subscriptions at Scale" information in the GraphQL specification.
+
+**Signature:**
+
+
+
+
+
+Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | args |
+ |
+ The arguments used to perform the operation. |
+
+
+
+
+
+
+Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The source event stream, or an execution result containing subscription errors. |
+
+
+
+
+
+
+Example
+
+```ts
+import { parse } from 'graphql/language';
+import { buildSchema } from 'graphql/utilities';
+import { createSourceEventStream } from 'graphql/execution';
+
+async function* greetings() {
+ yield { greeting: 'Hello' };
+}
+
+const schema = buildSchema(`
+ type Query {
+ noop: String
+ }
+
+ type Subscription {
+ greeting: String
+ }
+`);
+
+const stream = await createSourceEventStream({
+ schema,
+ document: parse('subscription { greeting }'),
+ rootValue: { greeting: () => greetings() },
+});
+
+Symbol.asyncIterator in stream; // => true
+```
+
+
+
+Overload 2
+
+Creates the source event stream for a subscription operation using the legacy
+positional argument overload. This deprecated overload will be removed in the
+next major version; use the args object overload instead.
+
+**Signature:**
+
+
+
+
+
+Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | schema |
+ |
+ GraphQL schema to use. |
+
+
+ | document |
+ |
+ The parsed GraphQL document containing the subscription
+operation. |
+
+
+ | rootValue? |
+ |
+ Initial root value passed to the subscription resolver. |
+
+
+ | contextValue? |
+ |
+ Application context value passed to resolvers. |
+
+
+ | variableValues? |
+ |
+ Runtime variable values keyed by variable name. |
+
+
+ | operationName? |
+ |
+ Name of the subscription operation to execute when
+the document contains multiple operations. |
+
+
+ | subscribeFieldResolver? |
+ |
+ Resolver used for the root subscription
+field. |
+
+
+
+
+
+
+Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The source event stream, or an execution result containing
+subscription errors. |
+
+
+
+
+
+
+Example
+
+```ts
+import { parse } from 'graphql/language';
+import { buildSchema } from 'graphql/utilities';
+import { createSourceEventStream } from 'graphql/execution';
+
+async function* greetings() {
+ yield { greeting: 'Hello' };
+}
+
+const schema = buildSchema(`
+ type Query {
+ noop: String
+ }
+
+ type Subscription {
+ greeting: String
+ }
+`);
+const document = parse('subscription { greeting }');
+
+const stream = await createSourceEventStream(schema, document, {
+ greeting: () => greetings(),
+});
+
+Symbol.asyncIterator in stream; // => true
+```
+
## Types
-### SubscriptionArgs Deprecated
+### SubscriptionArgs
**Interface.** Deprecated legacy alias for ExecutionArgs retained by the subscription
module. Use [`ExecutionArgs`](/api-v16/execution#executionargs) directly instead because SubscriptionArgs will be
diff --git a/website/pages/api-v16/type.mdx b/website/pages/api-v16/type.mdx
index 07c243b495..a373adc391 100644
--- a/website/pages/api-v16/type.mdx
+++ b/website/pages/api-v16/type.mdx
@@ -245,8 +245,12 @@ assertEnumValueName('true'); // throws an error
·
assertInputObjectType()
·
+ isListType()
+ ·
assertListType()
·
+ isNonNullType()
+ ·
assertNonNullType()
·
isInputType()
@@ -277,10 +281,14 @@ assertEnumValueName('true'); // throws an error
·
assertNullableType()
·
+ getNullableType()
+ ·
isNamedType()
·
assertNamedType()
·
+ getNamedType()
+ ·
resolveReadonlyArrayThunk()
·
resolveObjMapThunk()
@@ -4128,13 +4136,17 @@ assertInputObjectType(schema.getType('Review')); // throws an error
-#### assertListType()
+#### isListType()
-Returns the value as a GraphQLList, or throws if it is not one.
+
+
+Overload 1
+
+Returns true when the value is a GraphQLList.
**Signature:**
-
+
@@ -4151,7 +4163,7 @@ Returns the value as a GraphQLList, or throws if it is not one.
|
| type |
- |
+ |
The GraphQL type to inspect. |
@@ -4170,8 +4182,8 @@ Returns the value as a GraphQLList, or throws if it is not one.
- |
- The value typed as a GraphQLList. |
+ |
+ True when the value is a GraphQLList. |
@@ -4181,23 +4193,31 @@ Returns the value as a GraphQLList, or throws if it is not one.
Example
```ts
-import { GraphQLList, GraphQLString, assertListType } from 'graphql/type';
+import { buildSchema } from 'graphql/utilities';
+import { GraphQLList, GraphQLString, isListType } from 'graphql/type';
-const listType = assertListType(new GraphQLList(GraphQLString));
+const schema = buildSchema(`
+ type Query {
+ tags: [String!]!
+ }
+`);
-listType.ofType; // => GraphQLString
-assertListType(GraphQLString); // throws an error
+const tagsField = schema.getQueryType()?.getFields().tags;
+
+isListType(new GraphQLList(GraphQLString)); // => true
+isListType(GraphQLString); // => false
+isListType(tagsField?.type); // => false
```
-
+
-#### assertNonNullType()
+
Overload 2
-Returns the value as a GraphQLNonNull, or throws if it is not one.
+Returns true when the output type is a GraphQLList.
**Signature:**
-
+
@@ -4214,8 +4234,8 @@ Returns the value as a GraphQLNonNull, or throws if it is not one.
| type |
- |
- The GraphQL type to inspect. |
+ |
+ The GraphQL output type to inspect. |
@@ -4233,8 +4253,8 @@ Returns the value as a GraphQLNonNull, or throws if it is not one.
- |
- The value typed as a GraphQLNonNull. |
+ |
+ True when the output type is a list type. |
@@ -4244,23 +4264,30 @@ Returns the value as a GraphQLNonNull, or throws if it is not one.
Example
```ts
-import { GraphQLNonNull, GraphQLString, assertNonNullType } from 'graphql/type';
+import { buildSchema } from 'graphql/utilities';
+import { getNullableType, isListType } from 'graphql/type';
-const nonNullType = assertNonNullType(new GraphQLNonNull(GraphQLString));
+const schema = buildSchema(`
+ type Query {
+ tags: [String!]!
+ }
+`);
-nonNullType.ofType; // => GraphQLString
-assertNonNullType(GraphQLString); // throws an error
+const tagsField = schema.getQueryType()?.getFields().tags;
+const nullableTagsType = getNullableType(tagsField?.type);
+
+isListType(nullableTagsType); // => true
```
-
+
-#### isInputType()
+
Overload 3
-Returns true when the value can be used as a GraphQL input type.
+Returns true when the value is a GraphQLList.
**Signature:**
-
+
@@ -4278,7 +4305,7 @@ Returns true when the value can be used as a GraphQL input type.
| type |
|
- The GraphQL type to inspect. |
+ The value to inspect. |
@@ -4296,8 +4323,8 @@ Returns true when the value can be used as a GraphQL input type.
- |
- True when the value can be used as a GraphQL input type. |
+ |
+ True when the value is a list type. |
@@ -4307,36 +4334,21 @@ Returns true when the value can be used as a GraphQL input type.
Example
```ts
-import { buildSchema } from 'graphql/utilities';
-import { isInputType } from 'graphql/type';
-
-const schema = buildSchema(`
- input ReviewInput {
- stars: Int!
- }
-
- type Review {
- stars: Int!
- }
-
- type Query {
- review(input: ReviewInput): Review
- }
-`);
+import { isListType } from 'graphql/type';
-isInputType(schema.getType('ReviewInput')); // => true
-isInputType(schema.getType('Review')); // => false
+isListType('[String]'); // => false
+isListType(null); // => false
```
-#### assertInputType()
+#### assertListType()
-Returns the value as a GraphQL input type, or throws if it is not one.
+Returns the value as a GraphQLList, or throws if it is not one.
**Signature:**
-
+
@@ -4372,8 +4384,8 @@ Returns the value as a GraphQL input type, or throws if it is not one.
- |
- The value typed as a GraphQL input type. |
+ |
+ The value typed as a GraphQLList. |
@@ -4383,38 +4395,27 @@ Returns the value as a GraphQL input type, or throws if it is not one.
Example
```ts
-import { buildSchema } from 'graphql/utilities';
-import { assertInputType } from 'graphql/type';
-
-const schema = buildSchema(`
- input ReviewInput {
- stars: Int!
- }
-
- type Review {
- stars: Int!
- }
-
- type Query {
- review(input: ReviewInput): Review
- }
-`);
+import { GraphQLList, GraphQLString, assertListType } from 'graphql/type';
-const inputType = assertInputType(schema.getType('ReviewInput'));
+const listType = assertListType(new GraphQLList(GraphQLString));
-inputType.toString(); // => 'ReviewInput'
-assertInputType(schema.getType('Review')); // throws an error
+listType.ofType; // => GraphQLString
+assertListType(GraphQLString); // throws an error
```
-#### isOutputType()
+#### isNonNullType()
-Returns true when the value can be used as a GraphQL output type.
+
+
+
Overload 1
+
+Returns true when the value is a GraphQLNonNull.
**Signature:**
-
+
@@ -4431,7 +4432,7 @@ Returns true when the value can be used as a GraphQL output type.
| type |
- |
+ |
The GraphQL type to inspect. |
@@ -4450,8 +4451,8 @@ Returns true when the value can be used as a GraphQL output type.
- |
- True when the value can be used as a GraphQL output type. |
+ |
+ True when the value is a GraphQLNonNull. |
@@ -4462,35 +4463,31 @@ Returns true when the value can be used as a GraphQL output type.
```ts
import { buildSchema } from 'graphql/utilities';
-import { isOutputType } from 'graphql/type';
+import { GraphQLNonNull, GraphQLString, isNonNullType } from 'graphql/type';
const schema = buildSchema(`
- input ReviewInput {
- stars: Int!
- }
-
- type Review {
- stars: Int!
- }
-
type Query {
- review(input: ReviewInput): Review
+ name: String!
+ nickname: String
}
`);
-isOutputType(schema.getType('Review')); // => true
-isOutputType(schema.getType('ReviewInput')); // => false
+const fields = schema.getQueryType()?.getFields();
+
+isNonNullType(new GraphQLNonNull(GraphQLString)); // => true
+isNonNullType(fields?.name.type); // => true
+isNonNullType(fields?.nickname.type); // => false
```
-
+
-#### assertOutputType()
+
Overload 2
-Returns the value as a GraphQL output type, or throws if it is not one.
+Returns true when the output type is a GraphQLNonNull.
**Signature:**
-
+
@@ -4507,8 +4504,8 @@ Returns the value as a GraphQL output type, or throws if it is not one.
| type |
- |
- The GraphQL type to inspect. |
+ |
+ The GraphQL output type to inspect. |
@@ -4526,8 +4523,8 @@ Returns the value as a GraphQL output type, or throws if it is not one.
- |
- The value typed as a GraphQL output type. |
+ |
+ True when the output type is a non-null type. |
@@ -4538,37 +4535,30 @@ Returns the value as a GraphQL output type, or throws if it is not one.
```ts
import { buildSchema } from 'graphql/utilities';
-import { assertOutputType } from 'graphql/type';
+import { isNonNullType } from 'graphql/type';
const schema = buildSchema(`
- input ReviewInput {
- stars: Int!
- }
-
- type Review {
- stars: Int!
- }
-
type Query {
- review(input: ReviewInput): Review
+ name: String!
+ nickname: String
}
`);
-const outputType = assertOutputType(schema.getType('Review'));
+const fields = schema.getQueryType()?.getFields();
-outputType.toString(); // => 'Review'
-assertOutputType(schema.getType('ReviewInput')); // throws an error
+isNonNullType(fields?.name.type); // => true
+isNonNullType(fields?.nickname.type); // => false
```
-
+
-#### isLeafType()
+
Overload 3
-Returns true when the value is a GraphQL scalar or enum type.
+Returns true when the value is a GraphQLNonNull.
**Signature:**
-
+
@@ -4586,7 +4576,7 @@ Returns true when the value is a GraphQL scalar or enum type.
| type |
|
- The GraphQL type to inspect. |
+ The value to inspect. |
@@ -4604,8 +4594,8 @@ Returns true when the value is a GraphQL scalar or enum type.
- |
- True when the value is a GraphQL scalar or enum type. |
+ |
+ True when the value is a non-null type. |
@@ -4615,38 +4605,21 @@ Returns true when the value is a GraphQL scalar or enum type.
Example
```ts
-import { buildSchema } from 'graphql/utilities';
-import { isLeafType } from 'graphql/type';
-
-const schema = buildSchema(`
- enum Episode {
- NEW_HOPE
- }
-
- type Review {
- stars: Int!
- }
+import { isNonNullType } from 'graphql/type';
- type Query {
- episode: Episode
- review: Review
- }
-`);
-
-isLeafType(schema.getType('Episode')); // => true
-isLeafType(schema.getType('String')); // => true
-isLeafType(schema.getType('Review')); // => false
+isNonNullType('String!'); // => false
+isNonNullType(null); // => false
```
-#### assertLeafType()
+#### assertNonNullType()
-Returns the value as a GraphQL leaf type, or throws if it is not one.
+Returns the value as a GraphQLNonNull, or throws if it is not one.
**Signature:**
-
+
@@ -4682,8 +4655,8 @@ Returns the value as a GraphQL leaf type, or throws if it is not one.
- |
- The value typed as a GraphQL leaf type. |
+ |
+ The value typed as a GraphQLNonNull. |
@@ -4693,39 +4666,23 @@ Returns the value as a GraphQL leaf type, or throws if it is not one.
Example
```ts
-import { buildSchema } from 'graphql/utilities';
-import { assertLeafType } from 'graphql/type';
-
-const schema = buildSchema(`
- enum Episode {
- NEW_HOPE
- }
-
- type Review {
- stars: Int!
- }
-
- type Query {
- episode: Episode
- review: Review
- }
-`);
+import { GraphQLNonNull, GraphQLString, assertNonNullType } from 'graphql/type';
-const episodeType = assertLeafType(schema.getType('Episode'));
+const nonNullType = assertNonNullType(new GraphQLNonNull(GraphQLString));
-episodeType.toString(); // => 'Episode'
-assertLeafType(schema.getType('Review')); // throws an error
+nonNullType.ofType; // => GraphQLString
+assertNonNullType(GraphQLString); // throws an error
```
-#### isCompositeType()
+#### isInputType()
-Returns true when the value is a GraphQL object, interface, or union type.
+Returns true when the value can be used as a GraphQL input type.
**Signature:**
-
+
@@ -4761,8 +4718,8 @@ Returns true when the value is a GraphQL object, interface, or union type.
- |
- True when the value is a GraphQL object, interface, or union type. |
+ |
+ True when the value can be used as a GraphQL input type. |
@@ -4773,40 +4730,35 @@ Returns true when the value is a GraphQL object, interface, or union type.
```ts
import { buildSchema } from 'graphql/utilities';
-import { isCompositeType } from 'graphql/type';
+import { isInputType } from 'graphql/type';
const schema = buildSchema(`
- interface Node {
- id: ID!
+ input ReviewInput {
+ stars: Int!
}
- type User implements Node {
- id: ID!
+ type Review {
+ stars: Int!
}
- union SearchResult = User
-
type Query {
- node: Node
- search: [SearchResult]
+ review(input: ReviewInput): Review
}
`);
-isCompositeType(schema.getType('User')); // => true
-isCompositeType(schema.getType('Node')); // => true
-isCompositeType(schema.getType('SearchResult')); // => true
-isCompositeType(schema.getType('String')); // => false
+isInputType(schema.getType('ReviewInput')); // => true
+isInputType(schema.getType('Review')); // => false
```
-#### assertCompositeType()
+#### assertInputType()
-Returns the value as a GraphQL composite type, or throws if it is not one.
+Returns the value as a GraphQL input type, or throws if it is not one.
**Signature:**
-
+
@@ -4842,8 +4794,8 @@ Returns the value as a GraphQL composite type, or throws if it is not one.
- |
- The value typed as a GraphQL composite type. |
+ |
+ The value typed as a GraphQL input type. |
@@ -4854,37 +4806,993 @@ Returns the value as a GraphQL composite type, or throws if it is not one.
```ts
import { buildSchema } from 'graphql/utilities';
-import { assertCompositeType } from 'graphql/type';
+import { assertInputType } from 'graphql/type';
const schema = buildSchema(`
- interface Node {
- id: ID!
+ input ReviewInput {
+ stars: Int!
}
- type User implements Node {
- id: ID!
+ type Review {
+ stars: Int!
}
type Query {
- node: Node
+ review(input: ReviewInput): Review
}
`);
-const userType = assertCompositeType(schema.getType('User'));
+const inputType = assertInputType(schema.getType('ReviewInput'));
-userType.toString(); // => 'User'
-assertCompositeType(schema.getType('String')); // throws an error
+inputType.toString(); // => 'ReviewInput'
+assertInputType(schema.getType('Review')); // throws an error
+```
+
+
+
+#### isOutputType()
+
+Returns true when the value can be used as a GraphQL output type.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ True when the value can be used as a GraphQL output type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { buildSchema } from 'graphql/utilities';
+import { isOutputType } from 'graphql/type';
+
+const schema = buildSchema(`
+ input ReviewInput {
+ stars: Int!
+ }
+
+ type Review {
+ stars: Int!
+ }
+
+ type Query {
+ review(input: ReviewInput): Review
+ }
+`);
+
+isOutputType(schema.getType('Review')); // => true
+isOutputType(schema.getType('ReviewInput')); // => false
+```
+
+
+
+#### assertOutputType()
+
+Returns the value as a GraphQL output type, or throws if it is not one.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The value typed as a GraphQL output type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { buildSchema } from 'graphql/utilities';
+import { assertOutputType } from 'graphql/type';
+
+const schema = buildSchema(`
+ input ReviewInput {
+ stars: Int!
+ }
+
+ type Review {
+ stars: Int!
+ }
+
+ type Query {
+ review(input: ReviewInput): Review
+ }
+`);
+
+const outputType = assertOutputType(schema.getType('Review'));
+
+outputType.toString(); // => 'Review'
+assertOutputType(schema.getType('ReviewInput')); // throws an error
+```
+
+
+
+#### isLeafType()
+
+Returns true when the value is a GraphQL scalar or enum type.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ True when the value is a GraphQL scalar or enum type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { buildSchema } from 'graphql/utilities';
+import { isLeafType } from 'graphql/type';
+
+const schema = buildSchema(`
+ enum Episode {
+ NEW_HOPE
+ }
+
+ type Review {
+ stars: Int!
+ }
+
+ type Query {
+ episode: Episode
+ review: Review
+ }
+`);
+
+isLeafType(schema.getType('Episode')); // => true
+isLeafType(schema.getType('String')); // => true
+isLeafType(schema.getType('Review')); // => false
```
-#### isAbstractType()
+#### assertLeafType()
+
+Returns the value as a GraphQL leaf type, or throws if it is not one.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The value typed as a GraphQL leaf type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { buildSchema } from 'graphql/utilities';
+import { assertLeafType } from 'graphql/type';
+
+const schema = buildSchema(`
+ enum Episode {
+ NEW_HOPE
+ }
+
+ type Review {
+ stars: Int!
+ }
+
+ type Query {
+ episode: Episode
+ review: Review
+ }
+`);
+
+const episodeType = assertLeafType(schema.getType('Episode'));
+
+episodeType.toString(); // => 'Episode'
+assertLeafType(schema.getType('Review')); // throws an error
+```
+
+
+
+#### isCompositeType()
+
+Returns true when the value is a GraphQL object, interface, or union type.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ True when the value is a GraphQL object, interface, or union type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { buildSchema } from 'graphql/utilities';
+import { isCompositeType } from 'graphql/type';
+
+const schema = buildSchema(`
+ interface Node {
+ id: ID!
+ }
+
+ type User implements Node {
+ id: ID!
+ }
+
+ union SearchResult = User
+
+ type Query {
+ node: Node
+ search: [SearchResult]
+ }
+`);
+
+isCompositeType(schema.getType('User')); // => true
+isCompositeType(schema.getType('Node')); // => true
+isCompositeType(schema.getType('SearchResult')); // => true
+isCompositeType(schema.getType('String')); // => false
+```
+
+
+
+#### assertCompositeType()
+
+Returns the value as a GraphQL composite type, or throws if it is not one.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The value typed as a GraphQL composite type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { buildSchema } from 'graphql/utilities';
+import { assertCompositeType } from 'graphql/type';
+
+const schema = buildSchema(`
+ interface Node {
+ id: ID!
+ }
+
+ type User implements Node {
+ id: ID!
+ }
+
+ type Query {
+ node: Node
+ }
+`);
+
+const userType = assertCompositeType(schema.getType('User'));
+
+userType.toString(); // => 'User'
+assertCompositeType(schema.getType('String')); // throws an error
+```
+
+
+
+#### isAbstractType()
+
+Returns true when the value is a GraphQL interface or union type.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ True when the value is a GraphQL interface or union type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { buildSchema } from 'graphql/utilities';
+import { isAbstractType } from 'graphql/type';
+
+const schema = buildSchema(`
+ interface Node {
+ id: ID!
+ }
+
+ type User implements Node {
+ id: ID!
+ }
+
+ union SearchResult = User
+
+ type Query {
+ node: Node
+ search: [SearchResult]
+ }
+`);
+
+isAbstractType(schema.getType('Node')); // => true
+isAbstractType(schema.getType('SearchResult')); // => true
+isAbstractType(schema.getType('User')); // => false
+```
+
+
+
+#### assertAbstractType()
+
+Returns the value as a GraphQL abstract type, or throws if it is not one.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The value typed as a GraphQL abstract type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { buildSchema } from 'graphql/utilities';
+import { assertAbstractType } from 'graphql/type';
+
+const schema = buildSchema(`
+ interface Node {
+ id: ID!
+ }
+
+ type User implements Node {
+ id: ID!
+ }
+
+ type Query {
+ node: Node
+ }
+`);
+
+const nodeType = assertAbstractType(schema.getType('Node'));
+
+nodeType.toString(); // => 'Node'
+assertAbstractType(schema.getType('User')); // throws an error
+```
+
+
+
+#### isWrappingType()
+
+Returns true when the value is a GraphQL list or non-null wrapper type.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ True when the value is a GraphQL list or non-null wrapper type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import {
+ GraphQLList,
+ GraphQLNonNull,
+ GraphQLString,
+ isWrappingType,
+} from 'graphql/type';
+
+isWrappingType(new GraphQLList(GraphQLString)); // => true
+isWrappingType(new GraphQLNonNull(GraphQLString)); // => true
+isWrappingType(GraphQLString); // => false
+```
+
+
+
+#### assertWrappingType()
+
+Returns the value as a GraphQL wrapping type, or throws if it is not one.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The value typed as a GraphQL wrapping type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { GraphQLList, GraphQLString, assertWrappingType } from 'graphql/type';
+
+const wrappingType = assertWrappingType(new GraphQLList(GraphQLString));
+
+wrappingType.toString(); // => '[String]'
+assertWrappingType(GraphQLString); // throws an error
+```
+
+
+
+#### isNullableType()
+
+Returns true when the value is a GraphQL type that can accept null.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ True when the value is a GraphQL type that can accept null. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { GraphQLNonNull, GraphQLString, isNullableType } from 'graphql/type';
+
+isNullableType(GraphQLString); // => true
+isNullableType(new GraphQLNonNull(GraphQLString)); // => false
+isNullableType(null); // => false
+```
+
+
+
+#### assertNullableType()
+
+Returns the value as a nullable GraphQL type, or throws if it is not one.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The value typed as a nullable GraphQL type. |
+
+
+
+
+
+
+
Example
+
+```ts
+import {
+ GraphQLNonNull,
+ GraphQLString,
+ assertNullableType,
+} from 'graphql/type';
+
+const nullableType = assertNullableType(GraphQLString);
+
+nullableType; // => GraphQLString
+assertNullableType(new GraphQLNonNull(GraphQLString)); // throws an error
+```
+
+
+
+#### getNullableType()
+
+
+
+
Overload 1
+
+Returns the nullable type.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL type to inspect. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { getNullableType } from 'graphql/type';
+
+getNullableType(null); // => undefined
+getNullableType(undefined); // => undefined
+```
+
+
+
+
Overload 2
+
+Returns the nullable type after removing one non-null wrapper.
+
+
+
+
Type Parameters
-Returns true when the value is a GraphQL interface or union type.
+
+
+
+ | Name |
+ Constraint |
+ Default |
+ Description |
+
+
+
+
+ | T |
+ |
+ |
+ The nullable GraphQL type returned after removing one non-null wrapper. |
+
+
+
**Signature:**
-
+
@@ -4901,8 +5809,8 @@ Returns true when the value is a GraphQL interface or union type.
| type |
- |
- The GraphQL type to inspect. |
+ |
+ A nullable type or non-null wrapper. |
@@ -4920,8 +5828,8 @@ Returns true when the value is a GraphQL interface or union type.
- |
- True when the value is a GraphQL interface or union type. |
+ |
+ The nullable type after removing one non-null wrapper, if present. |
@@ -4931,40 +5839,29 @@ Returns true when the value is a GraphQL interface or union type.
Example
```ts
-import { buildSchema } from 'graphql/utilities';
-import { isAbstractType } from 'graphql/type';
-
-const schema = buildSchema(`
- interface Node {
- id: ID!
- }
-
- type User implements Node {
- id: ID!
- }
-
- union SearchResult = User
+import {
+ GraphQLList,
+ GraphQLNonNull,
+ GraphQLString,
+ getNullableType,
+} from 'graphql/type';
- type Query {
- node: Node
- search: [SearchResult]
- }
-`);
+const requiredString = new GraphQLNonNull(GraphQLString);
+const stringList = new GraphQLList(GraphQLString);
-isAbstractType(schema.getType('Node')); // => true
-isAbstractType(schema.getType('SearchResult')); // => true
-isAbstractType(schema.getType('User')); // => false
+getNullableType(requiredString); // => GraphQLString
+getNullableType(stringList); // => stringList
```
-
+
-#### assertAbstractType()
+
Overload 3
-Returns the value as a GraphQL abstract type, or throws if it is not one.
+Returns the nullable type after removing one non-null wrapper.
**Signature:**
-
+
@@ -4981,7 +5878,7 @@ Returns the value as a GraphQL abstract type, or throws if it is not one.
| type |
- |
+ |
The GraphQL type to inspect. |
@@ -5000,8 +5897,8 @@ Returns the value as a GraphQL abstract type, or throws if it is not one.
- |
- The value typed as a GraphQL abstract type. |
+ |
+ The nullable type after removing one non-null wrapper, if present. |
@@ -5011,38 +5908,30 @@ Returns the value as a GraphQL abstract type, or throws if it is not one.
Example
```ts
-import { buildSchema } from 'graphql/utilities';
-import { assertAbstractType } from 'graphql/type';
-
-const schema = buildSchema(`
- interface Node {
- id: ID!
- }
-
- type User implements Node {
- id: ID!
- }
-
- type Query {
- node: Node
- }
-`);
+import {
+ GraphQLList,
+ GraphQLNonNull,
+ GraphQLString,
+ getNullableType,
+} from 'graphql/type';
-const nodeType = assertAbstractType(schema.getType('Node'));
+const requiredStringList = new GraphQLNonNull(
+ new GraphQLList(GraphQLString),
+);
-nodeType.toString(); // => 'Node'
-assertAbstractType(schema.getType('User')); // throws an error
+getNullableType(requiredStringList).toString(); // => '[String]'
+getNullableType(GraphQLString); // => GraphQLString
```
-#### isWrappingType()
+#### isNamedType()
-Returns true when the value is a GraphQL list or non-null wrapper type.
+Returns true when the value is a GraphQL named type.
**Signature:**
-
+
@@ -5078,8 +5967,8 @@ Returns true when the value is a GraphQL list or non-null wrapper type.
- |
- True when the value is a GraphQL list or non-null wrapper type. |
+ |
+ True when the value is a GraphQL named type. |
@@ -5089,27 +5978,22 @@ Returns true when the value is a GraphQL list or non-null wrapper type.
Example
```ts
-import {
- GraphQLList,
- GraphQLNonNull,
- GraphQLString,
- isWrappingType,
-} from 'graphql/type';
+import { GraphQLList, GraphQLString, isNamedType } from 'graphql/type';
-isWrappingType(new GraphQLList(GraphQLString)); // => true
-isWrappingType(new GraphQLNonNull(GraphQLString)); // => true
-isWrappingType(GraphQLString); // => false
+isNamedType(GraphQLString); // => true
+isNamedType(new GraphQLList(GraphQLString)); // => false
+isNamedType(null); // => false
```
-#### assertWrappingType()
+#### assertNamedType()
-Returns the value as a GraphQL wrapping type, or throws if it is not one.
+Returns the value as a GraphQL named type, or throws if it is not one.
**Signature:**
-
+
@@ -5145,8 +6029,8 @@ Returns the value as a GraphQL wrapping type, or throws if it is not one.
- |
- The value typed as a GraphQL wrapping type. |
+ |
+ The value typed as a GraphQL named type. |
@@ -5156,23 +6040,27 @@ Returns the value as a GraphQL wrapping type, or throws if it is not one.
Example
```ts
-import { GraphQLList, GraphQLString, assertWrappingType } from 'graphql/type';
+import { GraphQLList, GraphQLString, assertNamedType } from 'graphql/type';
-const wrappingType = assertWrappingType(new GraphQLList(GraphQLString));
+const namedType = assertNamedType(GraphQLString);
-wrappingType.toString(); // => '[String]'
-assertWrappingType(GraphQLString); // throws an error
+namedType.name; // => 'String'
+assertNamedType(new GraphQLList(GraphQLString)); // throws an error
```
-#### isNullableType()
+#### getNamedType()
-Returns true when the value is a GraphQL type that can accept null.
+
+
+
Overload 1
+
+Returns the named type.
**Signature:**
-
+
@@ -5189,7 +6077,7 @@ Returns true when the value is a GraphQL type that can accept null.
| type |
- |
+ |
The GraphQL type to inspect. |
@@ -5197,6 +6085,48 @@ Returns true when the value is a GraphQL type that can accept null.
+
Example
+
+```ts
+import { getNamedType } from 'graphql/type';
+
+getNamedType(null); // => undefined
+getNamedType(undefined); // => undefined
+```
+
+
+
+
Overload 2
+
+Returns the named input type after unwrapping all list and non-null wrappers.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | type |
+ |
+ The GraphQL input type to inspect. |
+
+
+
+
+
+
Returns
@@ -5208,8 +6138,8 @@ Returns true when the value is a GraphQL type that can accept null.
- |
- True when the value is a GraphQL type that can accept null. |
+ |
+ The named input type after unwrapping all wrappers. |
@@ -5219,22 +6149,33 @@ Returns true when the value is a GraphQL type that can accept null.
Example
```ts
-import { GraphQLNonNull, GraphQLString, isNullableType } from 'graphql/type';
+import { buildSchema } from 'graphql/utilities';
+import { getNamedType } from 'graphql/type';
-isNullableType(GraphQLString); // => true
-isNullableType(new GraphQLNonNull(GraphQLString)); // => false
-isNullableType(null); // => false
+const schema = buildSchema(`
+ input ReviewInput {
+ stars: Int!
+ }
+
+ type Query {
+ review(input: [ReviewInput!]!): Boolean
+ }
+`);
+
+const inputArg = schema.getQueryType()?.getFields().review.args[0];
+
+getNamedType(inputArg?.type).toString(); // => 'ReviewInput'
```
-
+
-#### assertNullableType()
+
Overload 3
-Returns the value as a nullable GraphQL type, or throws if it is not one.
+Returns the named output type after unwrapping all list and non-null wrappers.
**Signature:**
-
+
@@ -5251,8 +6192,8 @@ Returns the value as a nullable GraphQL type, or throws if it is not one.
| type |
- |
- The GraphQL type to inspect. |
+ |
+ The GraphQL output type to inspect. |
@@ -5270,8 +6211,8 @@ Returns the value as a nullable GraphQL type, or throws if it is not one.
- |
- The value typed as a nullable GraphQL type. |
+ |
+ The named output type after unwrapping all wrappers. |
@@ -5281,27 +6222,33 @@ Returns the value as a nullable GraphQL type, or throws if it is not one.
Example
```ts
-import {
- GraphQLNonNull,
- GraphQLString,
- assertNullableType,
-} from 'graphql/type';
+import { buildSchema } from 'graphql/utilities';
+import { getNamedType } from 'graphql/type';
-const nullableType = assertNullableType(GraphQLString);
+const schema = buildSchema(`
+ type User {
+ name: String
+ }
-nullableType; // => GraphQLString
-assertNullableType(new GraphQLNonNull(GraphQLString)); // throws an error
+ type Query {
+ users: [User!]!
+ }
+`);
+
+const usersField = schema.getQueryType()?.getFields().users;
+
+getNamedType(usersField?.type).toString(); // => 'User'
```
-
+
-#### isNamedType()
+
Overload 4
-Returns true when the value is a GraphQL named type.
+Returns the named type after unwrapping all list and non-null wrappers.
**Signature:**
-
+
@@ -5318,7 +6265,7 @@ Returns true when the value is a GraphQL named type.
| type |
- |
+ |
The GraphQL type to inspect. |
@@ -5337,8 +6284,8 @@ Returns true when the value is a GraphQL named type.
- |
- True when the value is a GraphQL named type. |
+ |
+ The named type after unwrapping all wrappers. |
@@ -5348,22 +6295,29 @@ Returns true when the value is a GraphQL named type.
Example
```ts
-import { GraphQLList, GraphQLString, isNamedType } from 'graphql/type';
+import {
+ GraphQLList,
+ GraphQLNonNull,
+ GraphQLString,
+ getNamedType,
+} from 'graphql/type';
-isNamedType(GraphQLString); // => true
-isNamedType(new GraphQLList(GraphQLString)); // => false
-isNamedType(null); // => false
+const nestedType = new GraphQLNonNull(
+ new GraphQLList(new GraphQLNonNull(GraphQLString)),
+);
+
+getNamedType(nestedType); // => GraphQLString
```
-
+
-#### assertNamedType()
+
Overload 5
-Returns the value as a GraphQL named type, or throws if it is not one.
+Returns the named type after unwrapping all list and non-null wrappers.
**Signature:**
-
+
@@ -5380,7 +6334,7 @@ Returns the value as a GraphQL named type, or throws if it is not one.
| type |
- |
+ |
The GraphQL type to inspect. |
@@ -5399,8 +6353,8 @@ Returns the value as a GraphQL named type, or throws if it is not one.
- |
- The value typed as a GraphQL named type. |
+ |
+ The named type after unwrapping all wrappers, or undefined for nullish input. |
@@ -5410,12 +6364,14 @@ Returns the value as a GraphQL named type, or throws if it is not one.
Example
```ts
-import { GraphQLList, GraphQLString, assertNamedType } from 'graphql/type';
-
-const namedType = assertNamedType(GraphQLString);
+import {
+ GraphQLList,
+ GraphQLString,
+ getNamedType,
+} from 'graphql/type';
-namedType.name; // => 'String'
-assertNamedType(new GraphQLList(GraphQLString)); // throws an error
+getNamedType(new GraphQLList(GraphQLString)); // => GraphQLString
+getNamedType(undefined); // => undefined
```
diff --git a/website/pages/api-v16/utilities.mdx b/website/pages/api-v16/utilities.mdx
index dd5e26afc4..6d1d67f1cf 100644
--- a/website/pages/api-v16/utilities.mdx
+++ b/website/pages/api-v16/utilities.mdx
@@ -826,15 +826,15 @@ fields; // => [{ name: 'greeting', parentType: 'Query', type: 'String' }]
### Functions
-#### assertValidName()
Deprecated
+####
assertValidName()
Upholds the spec rules about naming. This deprecated helper is retained for
backwards compatibility; call [`assertName`](/api-v16/type#assertname) instead because assertValidName
@@ -897,7 +897,7 @@ assertValidName('__typename'); // throws an error
-#### isValidNameError()
Deprecated
+####
isValidNameError()
Returns an Error if a name is invalid. This deprecated helper is retained for
backwards compatibility; call [`assertName`](/api-v16/type#assertname) and catch the thrown GraphQLError
@@ -969,6 +969,8 @@ error.message; // => 'Name "__typename" must not begin with "__", which is reser
·
coerceInputValue()
·
+
typeFromAST()
+
·
valueFromAST()
·
valueFromASTUntyped()
@@ -1193,6 +1195,314 @@ errors; // => [ { path: [], invalidValue: null, message: 'Expected non-nullable
+#### typeFromAST()
+
+
+
+
Overload 1
+
+Given a Schema and an AST node describing a type, return a GraphQLType
+definition which applies to that type. For example, if provided the parsed
+AST node for `[User]`, a GraphQLList instance will be returned, containing
+the type called "User" found in the schema. If a type called "User" is not
+found in the schema, then undefined will be returned.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | schema |
+ |
+ GraphQL schema to use. |
+
+
+ | typeNode |
+ |
+ The GraphQL type AST node to resolve. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The GraphQL type referenced by the AST node, or undefined if it cannot be resolved. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { parseType } from 'graphql/language';
+import { buildSchema, typeFromAST } from 'graphql/utilities';
+
+const schema = buildSchema(`
+ type Query {
+ name: String
+ }
+`);
+
+typeFromAST(schema, parseType('String'))?.toString(); // => 'String'
+typeFromAST(schema, parseType('Missing')); // => undefined
+```
+
+
+
+
Overload 2
+
+Resolves a list type AST node against a schema.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | schema |
+ |
+ GraphQL schema to use. |
+
+
+ | typeNode |
+ |
+ The list type AST node to resolve. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The GraphQL list type referenced by the AST node, or undefined if
+it cannot be resolved. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { parseType } from 'graphql/language';
+import { buildSchema, typeFromAST } from 'graphql/utilities';
+
+const schema = buildSchema(`
+ type Query {
+ tags: [String]
+ }
+`);
+
+typeFromAST(schema, parseType('[String]'))?.toString(); // => '[String]'
+typeFromAST(schema, parseType('[Missing]')); // => undefined
+```
+
+
+
+
Overload 3
+
+Resolves a non-null type AST node against a schema.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | schema |
+ |
+ GraphQL schema to use. |
+
+
+ | typeNode |
+ |
+ The non-null type AST node to resolve. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The GraphQL non-null type referenced by the AST node, or undefined
+if it cannot be resolved. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { parseType } from 'graphql/language';
+import { buildSchema, typeFromAST } from 'graphql/utilities';
+
+const schema = buildSchema(`
+ type Query {
+ name: String!
+ }
+`);
+
+typeFromAST(schema, parseType('String!'))?.toString(); // => 'String!'
+typeFromAST(schema, parseType('[String!]!'))?.toString(); // => '[String!]!'
+```
+
+
+
+
Overload 4
+
+Resolves a type AST node against a schema.
+
+**Signature:**
+
+
+
+
+
+
Arguments
+
+
+
+
+ | Name |
+ Type |
+ Description |
+
+
+
+
+ | schema |
+ |
+ GraphQL schema to use. |
+
+
+ | typeNode |
+ |
+ The GraphQL type AST node to resolve. |
+
+
+
+
+
+
+
Returns
+
+
+
+
+ | Type |
+ Description |
+
+
+
+
+ |
+ The GraphQL type referenced by the AST node, or undefined if it
+cannot be resolved. |
+
+
+
+
+
+
+
Example
+
+```ts
+import { parseType } from 'graphql/language';
+import { buildSchema, typeFromAST } from 'graphql/utilities';
+
+const schema = buildSchema(`
+ type User {
+ name: String
+ }
+
+ type Query {
+ users: [User!]!
+ }
+`);
+
+typeFromAST(schema, parseType('User'))?.toString(); // => 'User'
+typeFromAST(schema, parseType('[User!]!'))?.toString(); // => '[User!]!'
+typeFromAST(schema, parseType('Missing')); // => undefined
+```
+
+
+
#### valueFromAST()
Produces a JavaScript value given a GraphQL Value AST.
@@ -3738,7 +4048,7 @@ changes[0].description; // matches /EMPIRE was added/
Functions:
getOperationAST()
·
-
getOperationRootType()
+
getOperationRootType()