graphql 16.14.0 → 16.14.1

package/type/definition.mjs

@@ -1,3 +1,4 @@
+/** @category Types */
 import { devAssert } from '../jsutils/devAssert.mjs';
 import { didYouMean } from '../jsutils/didYouMean.mjs';
 import { identityFunc } from '../jsutils/identityFunc.mjs';
@@ -14,6 +15,28 @@ import { Kind } from '../language/kinds.mjs';
 import { print } from '../language/printer.mjs';
 import { valueFromASTUntyped } from '../utilities/valueFromASTUntyped.mjs';
 import { assertEnumValueName, assertName } from './assertName.mjs';
+
+/**
+ * Returns true when the value is any GraphQL type.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the value is any GraphQL type.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { GraphQLList, GraphQLString, isType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * isType(GraphQLString); // => true
+ * isType(new GraphQLList(GraphQLString)); // => true
+ * isType(schema.getType('Query')); // => true
+ * isType('String'); // => false
+ * ```
+ */
 export function isType(type) {
   return (
     isScalarType(type) ||
@@ -26,6 +49,28 @@ export function isType(type) {
     isNonNullType(type)
   );
 }
+/**
+ * Returns the value as a GraphQL type, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQL type.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { assertType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String
+ *   }
+ * `);
+ *
+ * const queryType = assertType(schema.getType('Query'));
+ *
+ * queryType.toString(); // => 'Query'
+ * assertType('Query'); // throws an error
+ * ```
+ */
+
 export function assertType(type) {
   if (!isType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL type.`);
@@ -35,11 +80,53 @@ export function assertType(type) {
 }
 /**
  * There are predicates for each kind of GraphQL type.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the value is a GraphQLScalarType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { isScalarType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   scalar DateTime
+ *
+ *   type Query {
+ *     createdAt: DateTime
+ *   }
+ * `);
+ *
+ * isScalarType(schema.getType('DateTime')); // => true
+ * isScalarType(schema.getType('Query')); // => false
+ * ```
  */
 
 export function isScalarType(type) {
   return instanceOf(type, GraphQLScalarType);
 }
+/**
+ * Returns the value as a GraphQLScalarType, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQLScalarType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { assertScalarType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   scalar DateTime
+ *
+ *   type Query {
+ *     createdAt: DateTime
+ *   }
+ * `);
+ *
+ * const dateTimeType = assertScalarType(schema.getType('DateTime'));
+ *
+ * dateTimeType.name; // => 'DateTime'
+ * assertScalarType(schema.getType('Query')); // throws an error
+ * ```
+ */
+
 export function assertScalarType(type) {
   if (!isScalarType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL Scalar type.`);
@@ -47,9 +134,67 @@ export function assertScalarType(type) {
 
   return type;
 }
+/**
+ * Returns true when the value is a GraphQLObjectType.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the value is a GraphQLObjectType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { isObjectType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   input ReviewInput {
+ *     stars: Int!
+ *   }
+ *
+ *   type User {
+ *     name: String
+ *   }
+ *
+ *   type Query {
+ *     user: User
+ *   }
+ * `);
+ *
+ * isObjectType(schema.getType('User')); // => true
+ * isObjectType(schema.getType('ReviewInput')); // => false
+ * ```
+ */
+
 export function isObjectType(type) {
   return instanceOf(type, GraphQLObjectType);
 }
+/**
+ * Returns the value as a GraphQLObjectType, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQLObjectType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { assertObjectType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   input ReviewInput {
+ *     stars: Int!
+ *   }
+ *
+ *   type User {
+ *     name: String
+ *   }
+ *
+ *   type Query {
+ *     user: User
+ *   }
+ * `);
+ *
+ * const userType = assertObjectType(schema.getType('User'));
+ *
+ * Object.keys(userType.getFields()); // => ['name']
+ * assertObjectType(schema.getType('ReviewInput')); // throws an error
+ * ```
+ */
+
 export function assertObjectType(type) {
   if (!isObjectType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL Object type.`);
@@ -57,9 +202,67 @@ export function assertObjectType(type) {
 
   return type;
 }
+/**
+ * Returns true when the value is a GraphQLInterfaceType.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the value is a GraphQLInterfaceType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { isInterfaceType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   interface Node {
+ *     id: ID!
+ *   }
+ *
+ *   type User implements Node {
+ *     id: ID!
+ *   }
+ *
+ *   type Query {
+ *     node: Node
+ *   }
+ * `);
+ *
+ * isInterfaceType(schema.getType('Node')); // => true
+ * isInterfaceType(schema.getType('User')); // => false
+ * ```
+ */
+
 export function isInterfaceType(type) {
   return instanceOf(type, GraphQLInterfaceType);
 }
+/**
+ * Returns the value as a GraphQLInterfaceType, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQLInterfaceType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { assertInterfaceType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   interface Node {
+ *     id: ID!
+ *   }
+ *
+ *   type User implements Node {
+ *     id: ID!
+ *   }
+ *
+ *   type Query {
+ *     node: Node
+ *   }
+ * `);
+ *
+ * const nodeType = assertInterfaceType(schema.getType('Node'));
+ *
+ * nodeType.name; // => 'Node'
+ * assertInterfaceType(schema.getType('User')); // throws an error
+ * ```
+ */
+
 export function assertInterfaceType(type) {
   if (!isInterfaceType(type)) {
     throw new Error(
@@ -69,9 +272,71 @@ export function assertInterfaceType(type) {
 
   return type;
 }
+/**
+ * Returns true when the value is a GraphQLUnionType.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the value is a GraphQLUnionType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { isUnionType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   type Photo {
+ *     url: String!
+ *   }
+ *
+ *   type Video {
+ *     url: String!
+ *   }
+ *
+ *   union Media = Photo | Video
+ *
+ *   type Query {
+ *     media: [Media]
+ *   }
+ * `);
+ *
+ * isUnionType(schema.getType('Media')); // => true
+ * isUnionType(schema.getType('Photo')); // => false
+ * ```
+ */
+
 export function isUnionType(type) {
   return instanceOf(type, GraphQLUnionType);
 }
+/**
+ * Returns the value as a GraphQLUnionType, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQLUnionType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { assertUnionType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   type Photo {
+ *     url: String!
+ *   }
+ *
+ *   type Video {
+ *     url: String!
+ *   }
+ *
+ *   union Media = Photo | Video
+ *
+ *   type Query {
+ *     media: [Media]
+ *   }
+ * `);
+ *
+ * const mediaType = assertUnionType(schema.getType('Media'));
+ *
+ * mediaType.getTypes().map((type) => type.name); // => ['Photo', 'Video']
+ * assertUnionType(schema.getType('Photo')); // throws an error
+ * ```
+ */
+
 export function assertUnionType(type) {
   if (!isUnionType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL Union type.`);
@@ -79,9 +344,61 @@ export function assertUnionType(type) {
 
   return type;
 }
+/**
+ * Returns true when the value is a GraphQLEnumType.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the value is a GraphQLEnumType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { isEnumType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   enum Episode {
+ *     NEW_HOPE
+ *     EMPIRE
+ *   }
+ *
+ *   type Query {
+ *     favoriteEpisode: Episode
+ *   }
+ * `);
+ *
+ * isEnumType(schema.getType('Episode')); // => true
+ * isEnumType(schema.getType('Query')); // => false
+ * ```
+ */
+
 export function isEnumType(type) {
   return instanceOf(type, GraphQLEnumType);
 }
+/**
+ * Returns the value as a GraphQLEnumType, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQLEnumType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { assertEnumType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   enum Episode {
+ *     NEW_HOPE
+ *     EMPIRE
+ *   }
+ *
+ *   type Query {
+ *     favoriteEpisode: Episode
+ *   }
+ * `);
+ *
+ * const episodeType = assertEnumType(schema.getType('Episode'));
+ *
+ * episodeType.getValues().map((value) => value.name); // => ['NEW_HOPE', 'EMPIRE']
+ * assertEnumType(schema.getType('Query')); // throws an error
+ * ```
+ */
+
 export function assertEnumType(type) {
   if (!isEnumType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL Enum type.`);
@@ -89,9 +406,67 @@ export function assertEnumType(type) {
 
   return type;
 }
+/**
+ * Returns true when the value is a GraphQLInputObjectType.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the value is a GraphQLInputObjectType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { isInputObjectType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   input ReviewInput {
+ *     stars: Int!
+ *   }
+ *
+ *   type Review {
+ *     stars: Int!
+ *   }
+ *
+ *   type Query {
+ *     review(input: ReviewInput): Review
+ *   }
+ * `);
+ *
+ * isInputObjectType(schema.getType('ReviewInput')); // => true
+ * isInputObjectType(schema.getType('Review')); // => false
+ * ```
+ */
+
 export function isInputObjectType(type) {
   return instanceOf(type, GraphQLInputObjectType);
 }
+/**
+ * Returns the value as a GraphQLInputObjectType, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQLInputObjectType.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { assertInputObjectType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   input ReviewInput {
+ *     stars: Int!
+ *   }
+ *
+ *   type Review {
+ *     stars: Int!
+ *   }
+ *
+ *   type Query {
+ *     review(input: ReviewInput): Review
+ *   }
+ * `);
+ *
+ * const inputType = assertInputObjectType(schema.getType('ReviewInput'));
+ *
+ * Object.keys(inputType.getFields()); // => ['stars']
+ * assertInputObjectType(schema.getType('Review')); // throws an error
+ * ```
+ */
+
 export function assertInputObjectType(type) {
   if (!isInputObjectType(type)) {
     throw new Error(
@@ -101,9 +476,48 @@ export function assertInputObjectType(type) {
 
   return type;
 }
+/**
+ * Returns true when the value is a GraphQLList.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the value is a GraphQLList.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { GraphQLList, GraphQLString, isListType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     tags: [String!]!
+ *   }
+ * `);
+ *
+ * const tagsField = schema.getQueryType()?.getFields().tags;
+ *
+ * isListType(new GraphQLList(GraphQLString)); // => true
+ * isListType(GraphQLString); // => false
+ * isListType(tagsField?.type); // => false
+ * ```
+ */
+
+/** @internal */
 export function isListType(type) {
   return instanceOf(type, GraphQLList);
 }
+/**
+ * Returns the value as a GraphQLList, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQLList.
+ * @example
+ * ```ts
+ * import { GraphQLList, GraphQLString, assertListType } from 'graphql/type';
+ *
+ * const listType = assertListType(new GraphQLList(GraphQLString));
+ *
+ * listType.ofType; // => GraphQLString
+ * assertListType(GraphQLString); // throws an error
+ * ```
+ */
+
 export function assertListType(type) {
   if (!isListType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL List type.`);
@@ -111,9 +525,49 @@ export function assertListType(type) {
 
   return type;
 }
+/**
+ * Returns true when the value is a GraphQLNonNull.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the value is a GraphQLNonNull.
+ * @example
+ * ```ts
+ * import { buildSchema } from 'graphql/utilities';
+ * import { GraphQLNonNull, GraphQLString, isNonNullType } from 'graphql/type';
+ *
+ * const schema = buildSchema(`
+ *   type Query {
+ *     name: String!
+ *     nickname: String
+ *   }
+ * `);
+ *
+ * const fields = schema.getQueryType()?.getFields();
+ *
+ * isNonNullType(new GraphQLNonNull(GraphQLString)); // => true
+ * isNonNullType(fields?.name.type); // => true
+ * isNonNullType(fields?.nickname.type); // => false
+ * ```
+ */
+
+/** @internal */
 export function isNonNullType(type) {
   return instanceOf(type, GraphQLNonNull);
 }
+/**
+ * Returns the value as a GraphQLNonNull, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQLNonNull.
+ * @example
+ * ```ts
+ * import { GraphQLNonNull, GraphQLString, assertNonNullType } from 'graphql/type';
+ *
+ * const nonNullType = assertNonNullType(new GraphQLNonNull(GraphQLString));
+ *
+ * nonNullType.ofType; // => GraphQLString
+ * assertNonNullType(GraphQLString); // throws an error
+ * ```
+ */
+
 export function assertNonNullType(type) {
   if (!isNonNullType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL Non-Null type.`);
@@ -121,10 +575,35 @@ export function assertNonNullType(type) {
 
   return type;
 }
+/** These types may be used as input types for arguments and directives. */
+
 /**
- * These types may be used as input types for arguments and directives.
+ * Returns true when the value can be used as a GraphQL input type.
+ * @param type - The GraphQL type to inspect.
+ * @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
+ *   }
+ * `);
+ *
+ * isInputType(schema.getType('ReviewInput')); // => true
+ * isInputType(schema.getType('Review')); // => false
+ * ```
  */
-
 export function isInputType(type) {
   return (
     isScalarType(type) ||
@@ -133,6 +612,36 @@ export function isInputType(type) {
     (isWrappingType(type) && isInputType(type.ofType))
   );
 }
+/**
+ * Returns the value as a GraphQL input type, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQL input type.
+ * @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
+ *   }
+ * `);
+ *
+ * const inputType = assertInputType(schema.getType('ReviewInput'));
+ *
+ * inputType.toString(); // => 'ReviewInput'
+ * assertInputType(schema.getType('Review')); // throws an error
+ * ```
+ */
+
 export function assertInputType(type) {
   if (!isInputType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL input type.`);
@@ -140,10 +649,35 @@ export function assertInputType(type) {
 
   return type;
 }
+/** These types may be used as output types as the result of fields. */
+
 /**
- * These types may be used as output types as the result of fields.
+ * Returns true when the value can be used as a GraphQL output type.
+ * @param type - The GraphQL type to inspect.
+ * @returns 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
+ * ```
  */
-
 export function isOutputType(type) {
   return (
     isScalarType(type) ||
@@ -154,6 +688,36 @@ export function isOutputType(type) {
     (isWrappingType(type) && isOutputType(type.ofType))
   );
 }
+/**
+ * Returns the value as a GraphQL output type, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns 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
+ * ```
+ */
+
 export function assertOutputType(type) {
   if (!isOutputType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL output type.`);
@@ -161,13 +725,71 @@ export function assertOutputType(type) {
 
   return type;
 }
+/** These types may describe types which may be leaf values. */
+
 /**
- * These types may describe types which may be leaf values.
+ * Returns true when the value is a GraphQL scalar or enum type.
+ * @param type - The GraphQL type to inspect.
+ * @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!
+ *   }
+ *
+ *   type Query {
+ *     episode: Episode
+ *     review: Review
+ *   }
+ * `);
+ *
+ * isLeafType(schema.getType('Episode')); // => true
+ * isLeafType(schema.getType('String')); // => true
+ * isLeafType(schema.getType('Review')); // => false
+ * ```
  */
-
 export function isLeafType(type) {
   return isScalarType(type) || isEnumType(type);
 }
+/**
+ * Returns the value as a GraphQL leaf type, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns 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
+ * ```
+ */
+
 export function assertLeafType(type) {
   if (!isLeafType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL leaf type.`);
@@ -175,13 +797,73 @@ export function assertLeafType(type) {
 
   return type;
 }
+/** These types may describe the parent context of a selection set. */
+
 /**
- * These types may describe the parent context of a selection set.
+ * Returns true when the value is a GraphQL object, interface, or union type.
+ * @param type - The GraphQL type to inspect.
+ * @returns 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
+ * ```
  */
-
 export function isCompositeType(type) {
   return isObjectType(type) || isInterfaceType(type) || isUnionType(type);
 }
+/**
+ * Returns the value as a GraphQL composite type, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns 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
+ * ```
+ */
+
 export function assertCompositeType(type) {
   if (!isCompositeType(type)) {
     throw new Error(
@@ -191,13 +873,72 @@ export function assertCompositeType(type) {
 
   return type;
 }
+/** These types may describe the parent context of a selection set. */
+
 /**
- * These types may describe the parent context of a selection set.
+ * Returns true when the value is a GraphQL interface or union type.
+ * @param type - The GraphQL type to inspect.
+ * @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
+ *
+ *   type Query {
+ *     node: Node
+ *     search: [SearchResult]
+ *   }
+ * `);
+ *
+ * isAbstractType(schema.getType('Node')); // => true
+ * isAbstractType(schema.getType('SearchResult')); // => true
+ * isAbstractType(schema.getType('User')); // => false
+ * ```
  */
-
 export function isAbstractType(type) {
   return isInterfaceType(type) || isUnionType(type);
 }
+/**
+ * Returns the value as a GraphQL abstract type, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns 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
+ * ```
+ */
+
 export function assertAbstractType(type) {
   if (!isAbstractType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL abstract type.`);
@@ -211,9 +952,8 @@ export function assertAbstractType(type) {
  * A list is a wrapping type which points to another type.
  * Lists are often created within the context of defining the fields of
  * an object type.
- *
- * Example:
- *
+ * @typeParam T - The GraphQL type wrapped by this list type.
+ * @example
  * ```ts
  * const PersonType = new GraphQLObjectType({
  *   name: 'Person',
@@ -226,19 +966,65 @@ export function assertAbstractType(type) {
  */
 
 export class GraphQLList {
+  /** The type wrapped by this list or non-null type. */
+
+  /**
+   * Creates a GraphQLList instance.
+   * @param ofType - The type to wrap.
+   * @example
+   * ```ts
+   * import { GraphQLList, GraphQLString } from 'graphql/type';
+   *
+   * const stringList = new GraphQLList(GraphQLString);
+   *
+   * stringList.ofType; // => GraphQLString
+   * String(stringList); // => '[String]'
+   * ```
+   */
   constructor(ofType) {
     isType(ofType) ||
       devAssert(false, `Expected ${inspect(ofType)} to be a GraphQL type.`);
     this.ofType = ofType;
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'GraphQLList';
   }
+  /**
+   * Returns this wrapping type as a GraphQL type-reference string.
+   * @returns The GraphQL type-reference string.
+   * @example
+   * ```ts
+   * import { GraphQLList, GraphQLNonNull, GraphQLString } from 'graphql/type';
+   *
+   * const stringList = new GraphQLList(GraphQLString);
+   * const requiredStringList = new GraphQLList(new GraphQLNonNull(GraphQLString));
+   *
+   * stringList.toString(); // => '[String]'
+   * requiredStringList.toString(); // => '[String!]'
+   * ```
+   */
 
   toString() {
     return '[' + String(this.ofType) + ']';
   }
+  /**
+   * Returns the JSON representation used when this object is serialized.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { GraphQLList, GraphQLString } from 'graphql/type';
+   *
+   * const stringList = new GraphQLList(GraphQLString);
+   *
+   * stringList.toJSON(); // => '[String]'
+   * JSON.stringify({ type: stringList }); // => '{"type":"[String]"}'
+   * ```
+   */
 
   toJSON() {
     return this.toString();
@@ -252,9 +1038,8 @@ export class GraphQLList {
  * an error is raised if this ever occurs during a request. It is useful for
  * fields which you can make a strong guarantee on non-nullability, for example
  * usually the id field of a database row will never be null.
- *
- * Example:
- *
+ * @typeParam T - The nullable GraphQL type wrapped by this non-null type.
+ * @example
  * ```ts
  * const RowType = new GraphQLObjectType({
  *   name: 'Row',
@@ -263,10 +1048,26 @@ export class GraphQLList {
  *   })
  * })
  * ```
+ *
  * Note: the enforcement of non-nullability occurs within the executor.
  */
 
 export class GraphQLNonNull {
+  /** The type wrapped by this list or non-null type. */
+
+  /**
+   * Creates a GraphQLNonNull instance.
+   * @param ofType - The type to wrap.
+   * @example
+   * ```ts
+   * import { GraphQLNonNull, GraphQLString } from 'graphql/type';
+   *
+   * const requiredString = new GraphQLNonNull(GraphQLString);
+   *
+   * requiredString.ofType; // => GraphQLString
+   * String(requiredString); // => 'String!'
+   * ```
+   */
   constructor(ofType) {
     isNullableType(ofType) ||
       devAssert(
@@ -275,26 +1076,90 @@ export class GraphQLNonNull {
       );
     this.ofType = ofType;
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'GraphQLNonNull';
   }
+  /**
+   * Returns this wrapping type as a GraphQL type-reference string.
+   * @returns The GraphQL type-reference string.
+   * @example
+   * ```ts
+   * import { GraphQLList, GraphQLNonNull, GraphQLString } from 'graphql/type';
+   *
+   * const requiredString = new GraphQLNonNull(GraphQLString);
+   * const requiredStringList = new GraphQLNonNull(
+   *   new GraphQLList(GraphQLString),
+   * );
+   *
+   * requiredString.toString(); // => 'String!'
+   * requiredStringList.toString(); // => '[String]!'
+   * ```
+   */
 
   toString() {
     return String(this.ofType) + '!';
   }
+  /**
+   * Returns the JSON representation used when this object is serialized.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { GraphQLNonNull, GraphQLString } from 'graphql/type';
+   *
+   * const requiredString = new GraphQLNonNull(GraphQLString);
+   *
+   * requiredString.toJSON(); // => 'String!'
+   * JSON.stringify({ type: requiredString }); // => '{"type":"String!"}'
+   * ```
+   */
 
   toJSON() {
     return this.toString();
   }
 }
+/** These types wrap and modify other types */
+
 /**
- * These types wrap and modify other types
+ * Returns true when the value is a GraphQL list or non-null wrapper type.
+ * @param type - The GraphQL type to inspect.
+ * @returns 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
+ * ```
  */
-
 export function isWrappingType(type) {
   return isListType(type) || isNonNullType(type);
 }
+/**
+ * Returns the value as a GraphQL wrapping type, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns 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
+ * ```
+ */
+
 export function assertWrappingType(type) {
   if (!isWrappingType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL wrapping type.`);
@@ -302,13 +1167,43 @@ export function assertWrappingType(type) {
 
   return type;
 }
+/** These types can all accept null as a value. */
+
 /**
- * These types can all accept null as a value.
+ * Returns true when the value is a GraphQL type that can accept null.
+ * @param type - The GraphQL type to inspect.
+ * @returns 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
+ * ```
  */
-
 export function isNullableType(type) {
   return isType(type) && !isNonNullType(type);
 }
+/**
+ * Returns the value as a nullable GraphQL type, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns 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
+ * ```
+ */
+
 export function assertNullableType(type) {
   if (!isNullableType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL nullable type.`);
@@ -316,15 +1211,40 @@ export function assertNullableType(type) {
 
   return type;
 }
+/**
+ * Returns the nullable type.
+ * @param type - The GraphQL type to inspect.
+ * @returns The nullable type after removing one non-null wrapper, if present.
+ * @example
+ * ```ts
+ * import { getNullableType } from 'graphql/type';
+ *
+ * getNullableType(null); // => undefined
+ * getNullableType(undefined); // => undefined
+ * ```
+ */
+
+/** @internal */
 export function getNullableType(type) {
   if (type) {
     return isNonNullType(type) ? type.ofType : type;
   }
 }
+/** These named types do not include modifiers like List or NonNull. */
+
 /**
- * These named types do not include modifiers like List or NonNull.
+ * Returns true when the value is a GraphQL named type.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the value is a GraphQL named type.
+ * @example
+ * ```ts
+ * import { GraphQLList, GraphQLString, isNamedType } from 'graphql/type';
+ *
+ * isNamedType(GraphQLString); // => true
+ * isNamedType(new GraphQLList(GraphQLString)); // => false
+ * isNamedType(null); // => false
+ * ```
  */
-
 export function isNamedType(type) {
   return (
     isScalarType(type) ||
@@ -335,6 +1255,21 @@ export function isNamedType(type) {
     isInputObjectType(type)
   );
 }
+/**
+ * Returns the value as a GraphQL named type, or throws if it is not one.
+ * @param type - The GraphQL type to inspect.
+ * @returns The value typed as a GraphQL named type.
+ * @example
+ * ```ts
+ * import { GraphQLList, GraphQLString, assertNamedType } from 'graphql/type';
+ *
+ * const namedType = assertNamedType(GraphQLString);
+ *
+ * namedType.name; // => 'String'
+ * assertNamedType(new GraphQLList(GraphQLString)); // throws an error
+ * ```
+ */
+
 export function assertNamedType(type) {
   if (!isNamedType(type)) {
     throw new Error(`Expected ${inspect(type)} to be a GraphQL named type.`);
@@ -342,6 +1277,20 @@ export function assertNamedType(type) {
 
   return type;
 }
+/**
+ * Returns the named type.
+ * @param type - The GraphQL type to inspect.
+ * @returns The named type after unwrapping all list and non-null wrappers.
+ * @example
+ * ```ts
+ * import { getNamedType } from 'graphql/type';
+ *
+ * getNamedType(null); // => undefined
+ * getNamedType(undefined); // => undefined
+ * ```
+ */
+
+/** @internal */
 export function getNamedType(type) {
   if (type) {
     let unwrappedType = type;
@@ -356,17 +1305,50 @@ export function getNamedType(type) {
 /**
  * Used while defining GraphQL types to allow for circular references in
  * otherwise immutable type definitions.
+ * @typeParam T - The element type returned by the thunk or array.
  */
 
+/**
+ * Resolves a thunked readonly array.
+ * @param thunk - The thunk or value to resolve.
+ * @returns The resolved readonly array.
+ * @typeParam T - The element type resolved from the thunk or array.
+ * @example
+ * ```ts
+ * import { GraphQLString, resolveReadonlyArrayThunk } from 'graphql/type';
+ *
+ * const lazyFields = resolveReadonlyArrayThunk(() => [GraphQLString]);
+ * const fields = resolveReadonlyArrayThunk([GraphQLString]);
+ *
+ * lazyFields; // => [GraphQLString]
+ * fields; // => [GraphQLString]
+ * ```
+ */
 export function resolveReadonlyArrayThunk(thunk) {
   return typeof thunk === 'function' ? thunk() : thunk;
 }
+/**
+ * Resolves a thunked object map.
+ * @param thunk - The thunk or value to resolve.
+ * @returns The resolved object map.
+ * @typeParam T - The object-map value type resolved from the thunk or map.
+ * @example
+ * ```ts
+ * import { GraphQLString, resolveObjMapThunk } from 'graphql/type';
+ *
+ * const lazyFields = resolveObjMapThunk(() => ({ name: GraphQLString }));
+ * const fields = resolveObjMapThunk({ name: GraphQLString });
+ *
+ * lazyFields.name; // => GraphQLString
+ * fields.name; // => GraphQLString
+ * ```
+ */
+
 export function resolveObjMapThunk(thunk) {
   return typeof thunk === 'function' ? thunk() : thunk;
 }
 /**
  * Custom extensions
- *
  * @remarks
  * Use a unique identifier name for your extension, for example the name of
  * your library or project. Do not use a shortened identifier as this increases
@@ -377,20 +1359,22 @@ export function resolveObjMapThunk(thunk) {
 /**
  * Scalar Type Definition
  *
- * The leaf values of any request and input values to arguments are
- * Scalars (or Enums) and are defined with a name and a series of functions
- * used to parse input from ast or variables and to ensure validity.
+ * Scalar types define the leaf values of a GraphQL response and the input
+ * values accepted by arguments and input object fields. A scalar type has a
+ * name and coercion functions that validate and convert runtime values and
+ * GraphQL literals.
  *
  * If a type's serialize function returns `null` or does not return a value
  * (i.e. it returns `undefined`) then an error will be raised and a `null`
- * value will be returned in the response. It is always better to validate
- *
- * Example:
- *
+ * value will be returned in the response. Prefer validating inputs before
+ * execution so clients receive input diagnostics before result coercion fails.
+ * @typeParam TInternal - The internal runtime representation accepted by this scalar.
+ * @typeParam TExternal - The serialized representation exposed in GraphQL results.
+ * @example
  * ```ts
  * const OddType = new GraphQLScalarType({
  *   name: 'Odd',
- *   serialize(value) {
+ *   serialize: (value) => {
  *     if (!Number.isFinite(value)) {
  *       throw new Error(
  *         `Scalar "Odd" cannot represent "${value}" since it is not a finite number.`,
@@ -406,6 +1390,77 @@ export function resolveObjMapThunk(thunk) {
  * ```
  */
 export class GraphQLScalarType {
+  /** The GraphQL name for this schema element. */
+
+  /** Human-readable description for this schema element, if provided. */
+
+  /** URL identifying the behavior specified for this custom scalar. */
+
+  /** Function that converts internal values to externally visible scalar values. */
+
+  /** Function that converts variable input into this scalar's internal value. */
+
+  /** Function that converts AST input literals into this scalar's internal value. */
+
+  /** Extension fields to include in the formatted result. */
+
+  /** AST node from which this schema element was built, if available. */
+
+  /** AST extension nodes applied to this schema element. */
+
+  /**
+   * Creates a GraphQLScalarType instance.
+   * @param config - Configuration describing this object.
+   * @example
+   * ```ts
+   * import { Kind, parse } from 'graphql/language';
+   * import { GraphQLScalarType } from 'graphql/type';
+   *
+   * const document = parse(`
+   *   "Odd integer values."
+   *   scalar Odd @specifiedBy(url: "https://example.com/odd")
+   *
+   *   extend scalar Odd @specifiedBy(url: "https://example.com/odd-v2")
+   * `);
+   *
+   * const Odd = new GraphQLScalarType({
+   *   name: 'Odd',
+   *   description: 'Odd integer values.',
+   *   specifiedByURL: 'https://example.com/odd',
+   *   serialize: (value) => {
+   *     if (typeof value !== 'number' || value % 2 === 0) {
+   *       throw new TypeError('Odd can only serialize odd numbers.');
+   *     }
+   *     return value;
+   *   },
+   *   parseValue: (value) => {
+   *     if (typeof value !== 'number' || value % 2 === 0) {
+   *       throw new TypeError('Odd can only parse odd numbers.');
+   *     }
+   *     return value;
+   *   },
+   *   parseLiteral: (ast) => {
+   *     if (ast.kind !== Kind.INT) {
+   *       throw new TypeError('Odd can only parse integer literals.');
+   *     }
+   *     const value = Number(ast.value);
+   *     if (value % 2 === 0) {
+   *       throw new TypeError('Odd can only parse odd integer literals.');
+   *     }
+   *     return value;
+   *   },
+   *   extensions: { numeric: true },
+   *   astNode: document.definitions[0],
+   *   extensionASTNodes: [ document.definitions[1] ],
+   * });
+   *
+   * Odd.description; // => 'Odd integer values.'
+   * Odd.specifiedByURL; // => 'https://example.com/odd'
+   * Odd.serialize(3); // => 3
+   * Odd.parseValue(5); // => 5
+   * Odd.extensions; // => { numeric: true }
+   * ```
+   */
   constructor(config) {
     var _config$parseValue,
       _config$serialize,
@@ -461,10 +1516,35 @@ export class GraphQLScalarType {
         );
     }
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'GraphQLScalarType';
   }
+  /**
+   * Returns a normalized configuration object for this object.
+   * @returns A configuration object that can be used to recreate this object.
+   * @example
+   * ```ts
+   * import { GraphQLScalarType } from 'graphql/type';
+   *
+   * const Url = new GraphQLScalarType({
+   *   name: 'Url',
+   *   description: 'An absolute URL string.',
+   *   specifiedByURL: 'https://url.spec.whatwg.org/',
+   * });
+   *
+   * const config = Url.toConfig();
+   * const UrlCopy = new GraphQLScalarType(config);
+   *
+   * config.name; // => 'Url'
+   * config.specifiedByURL; // => 'https://url.spec.whatwg.org/'
+   * UrlCopy.name; // => Url.name
+   * ```
+   */
 
   toConfig() {
     return {
@@ -479,24 +1559,54 @@ export class GraphQLScalarType {
       extensionASTNodes: this.extensionASTNodes,
     };
   }
+  /**
+   * Returns the schema coordinate identifying this scalar type.
+   * @returns The schema coordinate for this scalar type.
+   * @example
+   * ```ts
+   * import { GraphQLScalarType } from 'graphql/type';
+   *
+   * const DateTime = new GraphQLScalarType({ name: 'DateTime' });
+   *
+   * DateTime.toString(); // => 'DateTime'
+   * String(DateTime); // => 'DateTime'
+   * ```
+   */
 
   toString() {
     return this.name;
   }
+  /**
+   * Returns the JSON representation used when this object is serialized.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { GraphQLScalarType } from 'graphql/type';
+   *
+   * const DateTime = new GraphQLScalarType({ name: 'DateTime' });
+   *
+   * DateTime.toJSON(); // => 'DateTime'
+   * JSON.stringify({ type: DateTime }); // => '{"type":"DateTime"}'
+   * ```
+   */
 
   toJSON() {
     return this.toString();
   }
 }
+/**
+ * Serializes a runtime value as a scalar output value.
+ * @typeParam TExternal - The serialized representation returned for GraphQL results.
+ */
 
 /**
  * Object Type Definition
  *
  * Almost all of the GraphQL types you define will be object types. Object types
  * have a name, but most importantly describe their fields.
- *
- * Example:
- *
+ * @typeParam TSource - Source object type passed to resolvers.
+ * @typeParam TContext - Context object type passed to resolvers.
+ * @example
  * ```ts
  * const AddressType = new GraphQLObjectType({
  *   name: 'Address',
@@ -505,20 +1615,18 @@ export class GraphQLScalarType {
  *     number: { type: GraphQLInt },
  *     formatted: {
  *       type: GraphQLString,
- *       resolve(obj) {
+ *       resolve: (obj) => {
  *         return obj.number + ' ' + obj.street
  *       }
  *     }
  *   }
  * });
  * ```
- *
+ * @example
  * When two types need to refer to each other, or a type needs to refer to
  * itself in a field, you can use a function expression (aka a closure or a
  * thunk) to supply the fields lazily.
  *
- * Example:
- *
  * ```ts
  * const PersonType = new GraphQLObjectType({
  *   name: 'Person',
@@ -530,6 +1638,118 @@ export class GraphQLScalarType {
  * ```
  */
 export class GraphQLObjectType {
+  /** The GraphQL name for this schema element. */
+
+  /** Human-readable description for this schema element, if provided. */
+
+  /** Predicate used to determine whether a runtime value belongs to this object type. */
+
+  /** Extension fields to include in the formatted result. */
+
+  /** AST node from which this schema element was built, if available. */
+
+  /** AST extension nodes applied to this schema element. */
+
+  /**
+   * Creates a GraphQLObjectType instance.
+   * @param config - Configuration describing this object.
+   * @example
+   * ```ts
+   * // Configure an object type with interfaces, fields, arguments, and metadata.
+   * import { parse } from 'graphql/language';
+   * import {
+   *   GraphQLID,
+   *   GraphQLInterfaceType,
+   *   GraphQLNonNull,
+   *   GraphQLObjectType,
+   *   GraphQLString,
+   * } from 'graphql/type';
+   *
+   * const document = parse(`
+   *   type User implements Node {
+   *     id: ID!
+   *     name(format: String = "short"): String
+   *   }
+   *
+   *   extend type User {
+   *     displayName: String
+   *   }
+   * `);
+   * const definition = document.definitions[0];
+   * const nameField = definition.fields[1];
+   * const formatArg = nameField.arguments[0];
+   *
+   * const Node = new GraphQLInterfaceType({
+   *   name: 'Node',
+   *   fields: {
+   *     id: { type: new GraphQLNonNull(GraphQLID) },
+   *   },
+   * });
+   *
+   * const User = new GraphQLObjectType({
+   *   name: 'User',
+   *   description: 'A registered user.',
+   *   interfaces: [Node],
+   *   fields: {
+   *     id: { type: new GraphQLNonNull(GraphQLID) },
+   *     name: {
+   *       description: 'The formatted user name.',
+   *       type: GraphQLString,
+   *       args: {
+   *         format: {
+   *           description: 'Controls the name format.',
+   *           type: GraphQLString,
+   *           defaultValue: 'short',
+   *           deprecationReason: 'Use locale instead.',
+   *           extensions: { public: true },
+   *           astNode: formatArg,
+   *         },
+   *       },
+   *       resolve: (user, { format }) => {
+   *         return format === 'long' ? user.fullName : user.name;
+   *       },
+   *       deprecationReason: 'Use displayName.',
+   *       extensions: { cacheSeconds: 60 },
+   *       astNode: nameField,
+   *     },
+   *   },
+   *   isTypeOf: (value) => {
+   *     return typeof value === 'object' && value != null && 'id' in value;
+   *   },
+   *   extensions: { entity: 'User' },
+   *   astNode: definition,
+   *   extensionASTNodes: [ document.definitions[1] ],
+   * });
+   *
+   * User.name; // => 'User'
+   * User.getInterfaces(); // => [Node]
+   * Object.keys(User.getFields()); // => ['id', 'name']
+   * User.getFields().name.args[0].defaultValue; // => 'short'
+   * User.extensions; // => { entity: 'User' }
+   * ```
+   * @example
+   * ```ts
+   * // This variant configures a subscription field with subscribe and resolve functions.
+   * import { GraphQLObjectType, GraphQLString } from 'graphql/type';
+   *
+   * const Subscription = new GraphQLObjectType({
+   *   name: 'Subscription',
+   *   fields: {
+   *     greeting: {
+   *       type: GraphQLString,
+   *       subscribe: async function* () {
+   *         yield { greeting: 'Hello!' };
+   *       },
+   *       resolve: (event) => {
+   *         return event.greeting;
+   *       },
+   *     },
+   *   },
+   * });
+   *
+   * typeof Subscription.getFields().greeting.subscribe; // => 'function'
+   * ```
+   */
   constructor(config) {
     var _config$extensionASTN2;
 
@@ -556,10 +1776,40 @@ export class GraphQLObjectType {
           `but got: ${inspect(config.isTypeOf)}.`,
       );
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'GraphQLObjectType';
   }
+  /**
+   * Returns the fields defined by this type.
+   * @returns The fields keyed by field name.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertObjectType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   type User {
+   *     id: ID!
+   *     name: String
+   *   }
+   *
+   *   type Query {
+   *     viewer: User
+   *   }
+   * `);
+   *
+   * const User = assertObjectType(schema.getType('User'));
+   * const fields = User.getFields();
+   *
+   * Object.keys(fields); // => ['id', 'name']
+   * String(fields.id.type); // => 'ID!'
+   * ```
+   */
 
   getFields() {
     if (typeof this._fields === 'function') {
@@ -568,6 +1818,33 @@ export class GraphQLObjectType {
 
     return this._fields;
   }
+  /**
+   * Returns the interfaces implemented by this type.
+   * @returns The implemented interfaces.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertObjectType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   interface Node {
+   *     id: ID!
+   *   }
+   *
+   *   type User implements Node {
+   *     id: ID!
+   *   }
+   *
+   *   type Query {
+   *     viewer: User
+   *   }
+   * `);
+   *
+   * const User = assertObjectType(schema.getType('User'));
+   *
+   * User.getInterfaces().map((type) => type.name); // => ['Node']
+   * ```
+   */
 
   getInterfaces() {
     if (typeof this._interfaces === 'function') {
@@ -576,6 +1853,27 @@ export class GraphQLObjectType {
 
     return this._interfaces;
   }
+  /**
+   * Returns a normalized configuration object for this object.
+   * @returns A configuration object that can be used to recreate this object.
+   * @example
+   * ```ts
+   * import { GraphQLObjectType, GraphQLString } from 'graphql/type';
+   *
+   * const User = new GraphQLObjectType({
+   *   name: 'User',
+   *   fields: {
+   *     name: { type: GraphQLString },
+   *   },
+   * });
+   *
+   * const config = User.toConfig();
+   * const UserCopy = new GraphQLObjectType(config);
+   *
+   * config.fields.name.type; // => GraphQLString
+   * UserCopy.getFields().name.type; // => GraphQLString
+   * ```
+   */
 
   toConfig() {
     return {
@@ -589,10 +1887,49 @@ export class GraphQLObjectType {
       extensionASTNodes: this.extensionASTNodes,
     };
   }
+  /**
+   * Returns the schema coordinate identifying this object type.
+   * @returns The schema coordinate for this object type.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertObjectType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   type User {
+   *     name: String
+   *   }
+   *
+   *   type Query {
+   *     viewer: User
+   *   }
+   * `);
+   *
+   * const User = assertObjectType(schema.getType('User'));
+   *
+   * User.toString(); // => 'User'
+   * ```
+   */
 
   toString() {
     return this.name;
   }
+  /**
+   * Returns the JSON representation used when this object is serialized.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { GraphQLObjectType, GraphQLString } from 'graphql/type';
+   *
+   * const User = new GraphQLObjectType({
+   *   name: 'User',
+   *   fields: { name: { type: GraphQLString } },
+   * });
+   *
+   * User.toJSON(); // => 'User'
+   * JSON.stringify({ type: User }); // => '{"type":"User"}'
+   * ```
+   */
 
   toJSON() {
     return this.toString();
@@ -661,6 +1998,7 @@ function defineFieldMap(config) {
     };
   });
 }
+/** @internal */
 
 export function defineArguments(config) {
   return Object.entries(config).map(([argName, argConfig]) => ({
@@ -690,9 +2028,7 @@ function fieldsToFieldsConfig(fields) {
     astNode: field.astNode,
   }));
 }
-/**
- * @internal
- */
+/** @internal */
 
 export function argsToArgsConfig(args) {
   return keyValMap(
@@ -708,9 +2044,46 @@ export function argsToArgsConfig(args) {
     }),
   );
 }
+/**
+ * Configuration used to construct a GraphQLObjectType.
+ * @typeParam TSource - Source object type passed to resolvers.
+ * @typeParam TContext - Context object type passed to resolvers.
+ */
+
+/**
+ * Returns true when the argument is non-null and has no default value.
+ * @param arg - The argument definition to inspect.
+ * @returns True when the argument is non-null and has no default value.
+ * @example
+ * ```ts
+ * import {
+ *   GraphQLInt,
+ *   GraphQLNonNull,
+ *   GraphQLString,
+ *   isRequiredArgument,
+ * } from 'graphql/type';
+ *
+ * const requiredArgument = { name: 'id', type: new GraphQLNonNull(GraphQLInt) };
+ * const optionalArgument = { name: 'name', type: GraphQLString };
+ * const argumentWithDefault = {
+ *   name: 'limit',
+ *   type: new GraphQLNonNull(GraphQLInt),
+ *   defaultValue: 10,
+ * };
+ *
+ * isRequiredArgument(requiredArgument); // => true
+ * isRequiredArgument(optionalArgument); // => false
+ * isRequiredArgument(argumentWithDefault); // => false
+ * ```
+ */
 export function isRequiredArgument(arg) {
   return isNonNullType(arg.type) && arg.defaultValue === undefined;
 }
+/**
+ * A map of field names to resolved field definitions.
+ * @typeParam TSource - Source object type passed to resolvers.
+ * @typeParam TContext - Context object type passed to resolvers.
+ */
 
 /**
  * Interface Type Definition
@@ -719,9 +2092,7 @@ export function isRequiredArgument(arg) {
  * is used to describe what types are possible, what fields are in common across
  * all types, as well as a function to determine which type is actually used
  * when the field is resolved.
- *
- * Example:
- *
+ * @example
  * ```ts
  * const EntityType = new GraphQLInterfaceType({
  *   name: 'Entity',
@@ -732,6 +2103,70 @@ export function isRequiredArgument(arg) {
  * ```
  */
 export class GraphQLInterfaceType {
+  /** The GraphQL name for this schema element. */
+
+  /** Human-readable description for this schema element, if provided. */
+
+  /** Function that resolves the concrete object type for this abstract type. */
+
+  /** Extension fields to include in the formatted result. */
+
+  /** AST node from which this schema element was built, if available. */
+
+  /** AST extension nodes applied to this schema element. */
+
+  /**
+   * Creates a GraphQLInterfaceType instance.
+   * @param config - Configuration describing this object.
+   * @example
+   * ```ts
+   * import { parse } from 'graphql/language';
+   * import { GraphQLID, GraphQLInterfaceType, GraphQLNonNull } from 'graphql/type';
+   *
+   * const document = parse(`
+   *   interface Node {
+   *     id: ID!
+   *   }
+   *
+   *   interface Resource implements Node {
+   *     id: ID!
+   *   }
+   *
+   *   extend interface Resource {
+   *     url: String
+   *   }
+   * `);
+   *
+   * const Node = new GraphQLInterfaceType({
+   *   name: 'Node',
+   *   fields: {
+   *     id: { type: new GraphQLNonNull(GraphQLID) },
+   *   },
+   * });
+   *
+   * const Resource = new GraphQLInterfaceType({
+   *   name: 'Resource',
+   *   description: 'An addressable resource.',
+   *   interfaces: [Node],
+   *   fields: {
+   *     id: { type: new GraphQLNonNull(GraphQLID) },
+   *   },
+   *   resolveType: (value) => {
+   *     return typeof value === 'object' && value != null && 'url' in value
+   *       ? 'WebPage'
+   *       : null;
+   *   },
+   *   extensions: { abstract: true },
+   *   astNode: document.definitions[1],
+   *   extensionASTNodes: [ document.definitions[2] ],
+   * });
+   *
+   * Resource.name; // => 'Resource'
+   * Resource.getInterfaces(); // => [Node]
+   * Object.keys(Resource.getFields()); // => ['id']
+   * Resource.extensions; // => { abstract: true }
+   * ```
+   */
   constructor(config) {
     var _config$extensionASTN3;
 
@@ -755,10 +2190,43 @@ export class GraphQLInterfaceType {
           `but got: ${inspect(config.resolveType)}.`,
       );
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'GraphQLInterfaceType';
   }
+  /**
+   * Returns the fields defined by this type.
+   * @returns The fields keyed by field name.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertInterfaceType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   interface Node {
+   *     id: ID!
+   *   }
+   *
+   *   type User implements Node {
+   *     id: ID!
+   *   }
+   *
+   *   type Query {
+   *     node: Node
+   *   }
+   * `);
+   *
+   * const Node = assertInterfaceType(schema.getType('Node'));
+   * const fields = Node.getFields();
+   *
+   * Object.keys(fields); // => ['id']
+   * String(fields.id.type); // => 'ID!'
+   * ```
+   */
 
   getFields() {
     if (typeof this._fields === 'function') {
@@ -767,6 +2235,39 @@ export class GraphQLInterfaceType {
 
     return this._fields;
   }
+  /**
+   * Returns the interfaces implemented by this type.
+   * @returns The implemented interfaces.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertInterfaceType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   interface Resource {
+   *     url: String!
+   *   }
+   *
+   *   interface Image implements Resource {
+   *     url: String!
+   *     width: Int
+   *   }
+   *
+   *   type Photo implements Resource & Image {
+   *     url: String!
+   *     width: Int
+   *   }
+   *
+   *   type Query {
+   *     image: Image
+   *   }
+   * `);
+   *
+   * const Image = assertInterfaceType(schema.getType('Image'));
+   *
+   * Image.getInterfaces().map((type) => type.name); // => ['Resource']
+   * ```
+   */
 
   getInterfaces() {
     if (typeof this._interfaces === 'function') {
@@ -775,6 +2276,27 @@ export class GraphQLInterfaceType {
 
     return this._interfaces;
   }
+  /**
+   * Returns a normalized configuration object for this object.
+   * @returns A configuration object that can be used to recreate this object.
+   * @example
+   * ```ts
+   * import { GraphQLID, GraphQLInterfaceType, GraphQLNonNull } from 'graphql/type';
+   *
+   * const Node = new GraphQLInterfaceType({
+   *   name: 'Node',
+   *   fields: {
+   *     id: { type: new GraphQLNonNull(GraphQLID) },
+   *   },
+   * });
+   *
+   * const config = Node.toConfig();
+   * const NodeCopy = new GraphQLInterfaceType(config);
+   *
+   * String(config.fields.id.type); // => 'ID!'
+   * String(NodeCopy.getFields().id.type); // => 'ID!'
+   * ```
+   */
 
   toConfig() {
     return {
@@ -788,15 +2310,63 @@ export class GraphQLInterfaceType {
       extensionASTNodes: this.extensionASTNodes,
     };
   }
+  /**
+   * Returns the schema coordinate identifying this interface type.
+   * @returns The schema coordinate for this interface type.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertInterfaceType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   interface Node {
+   *     id: ID!
+   *   }
+   *
+   *   type User implements Node {
+   *     id: ID!
+   *   }
+   *
+   *   type Query {
+   *     node: Node
+   *   }
+   * `);
+   *
+   * const Node = assertInterfaceType(schema.getType('Node'));
+   *
+   * Node.toString(); // => 'Node'
+   * ```
+   */
 
   toString() {
     return this.name;
   }
+  /**
+   * Returns the JSON representation used when this object is serialized.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { GraphQLInterfaceType, GraphQLString } from 'graphql/type';
+   *
+   * const Named = new GraphQLInterfaceType({
+   *   name: 'Named',
+   *   fields: { name: { type: GraphQLString } },
+   * });
+   *
+   * Named.toJSON(); // => 'Named'
+   * JSON.stringify({ type: Named }); // => '{"type":"Named"}'
+   * ```
+   */
 
   toJSON() {
     return this.toString();
   }
 }
+/**
+ * Configuration used to construct a GraphQLInterfaceType.
+ * @typeParam TSource - Source object type passed to resolvers.
+ * @typeParam TContext - Context object type passed to resolvers.
+ */
 
 /**
  * Union Type Definition
@@ -804,14 +2374,12 @@ export class GraphQLInterfaceType {
  * When a field can return one of a heterogeneous set of types, a Union type
  * is used to describe what types are possible as well as providing a function
  * to determine which type is actually used when the field is resolved.
- *
- * Example:
- *
+ * @example
  * ```ts
  * const PetType = new GraphQLUnionType({
  *   name: 'Pet',
- *   types: [ DogType, CatType ],
- *   resolveType(value) {
+ *   types: [DogType, CatType],
+ *   resolveType: (value) => {
  *     if (value instanceof Dog) {
  *       return DogType;
  *     }
@@ -823,6 +2391,60 @@ export class GraphQLInterfaceType {
  * ```
  */
 export class GraphQLUnionType {
+  /** The GraphQL name for this schema element. */
+
+  /** Human-readable description for this schema element, if provided. */
+
+  /** Function that resolves the concrete object type for this abstract type. */
+
+  /** Extension fields to include in the formatted result. */
+
+  /** AST node from which this schema element was built, if available. */
+
+  /** AST extension nodes applied to this schema element. */
+
+  /**
+   * Creates a GraphQLUnionType instance.
+   * @param config - Configuration describing this object.
+   * @example
+   * ```ts
+   * import { parse } from 'graphql/language';
+   * import { GraphQLObjectType, GraphQLString, GraphQLUnionType } from 'graphql/type';
+   *
+   * const document = parse(`
+   *   union Media = Photo | Video
+   *
+   *   extend union Media = Audio
+   * `);
+   *
+   * const Photo = new GraphQLObjectType({
+   *   name: 'Photo',
+   *   fields: { url: { type: GraphQLString } },
+   * });
+   * const Video = new GraphQLObjectType({
+   *   name: 'Video',
+   *   fields: { url: { type: GraphQLString } },
+   * });
+   *
+   * const Media = new GraphQLUnionType({
+   *   name: 'Media',
+   *   description: 'Media that can appear in a search result.',
+   *   types: [Photo, Video],
+   *   resolveType: (value) => {
+   *     return typeof value === 'object' && value != null && 'duration' in value
+   *       ? 'Video'
+   *       : 'Photo';
+   *   },
+   *   extensions: { searchable: true },
+   *   astNode: document.definitions[0],
+   *   extensionASTNodes: [ document.definitions[1] ],
+   * });
+   *
+   * Media.description; // => 'Media that can appear in a search result.'
+   * Media.getTypes().map((type) => type.name); // => ['Photo', 'Video']
+   * Media.extensions; // => { searchable: true }
+   * ```
+   */
   constructor(config) {
     var _config$extensionASTN4;
 
@@ -845,10 +2467,43 @@ export class GraphQLUnionType {
           `but got: ${inspect(config.resolveType)}.`,
       );
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'GraphQLUnionType';
   }
+  /**
+   * Returns the object types included in this union.
+   * @returns The union member object types.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertUnionType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   type Photo {
+   *     url: String!
+   *   }
+   *
+   *   type Video {
+   *     url: String!
+   *   }
+   *
+   *   union Media = Photo | Video
+   *
+   *   type Query {
+   *     media: [Media]
+   *   }
+   * `);
+   *
+   * const Media = assertUnionType(schema.getType('Media'));
+   *
+   * Media.getTypes().map((type) => type.name); // => ['Photo', 'Video']
+   * ```
+   */
 
   getTypes() {
     if (typeof this._types === 'function') {
@@ -857,6 +2512,32 @@ export class GraphQLUnionType {
 
     return this._types;
   }
+  /**
+   * Returns a normalized configuration object for this object.
+   * @returns A configuration object that can be used to recreate this object.
+   * @example
+   * ```ts
+   * import { GraphQLObjectType, GraphQLString, GraphQLUnionType } from 'graphql/type';
+   *
+   * const Photo = new GraphQLObjectType({
+   *   name: 'Photo',
+   *   fields: { url: { type: GraphQLString } },
+   * });
+   * const Video = new GraphQLObjectType({
+   *   name: 'Video',
+   *   fields: { url: { type: GraphQLString } },
+   * });
+   * const Media = new GraphQLUnionType({
+   *   name: 'Media',
+   *   types: [Photo, Video],
+   * });
+   *
+   * const config = Media.toConfig();
+   * const MediaCopy = new GraphQLUnionType(config);
+   *
+   * MediaCopy.getTypes().map((type) => type.name); // => ['Photo', 'Video']
+   * ```
+   */
 
   toConfig() {
     return {
@@ -869,10 +2550,55 @@ export class GraphQLUnionType {
       extensionASTNodes: this.extensionASTNodes,
     };
   }
+  /**
+   * Returns the schema coordinate identifying this union type.
+   * @returns The schema coordinate for this union type.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertUnionType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   type Photo {
+   *     url: String!
+   *   }
+   *
+   *   union SearchResult = Photo
+   *
+   *   type Query {
+   *     search: [SearchResult]
+   *   }
+   * `);
+   *
+   * const SearchResult = assertUnionType(schema.getType('SearchResult'));
+   *
+   * SearchResult.toString(); // => 'SearchResult'
+   * ```
+   */
 
   toString() {
     return this.name;
   }
+  /**
+   * Returns the JSON representation used when this object is serialized.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { GraphQLObjectType, GraphQLString, GraphQLUnionType } from 'graphql/type';
+   *
+   * const Photo = new GraphQLObjectType({
+   *   name: 'Photo',
+   *   fields: { url: { type: GraphQLString } },
+   * });
+   * const SearchResult = new GraphQLUnionType({
+   *   name: 'SearchResult',
+   *   types: [Photo],
+   * });
+   *
+   * SearchResult.toJSON(); // => 'SearchResult'
+   * JSON.stringify({ type: SearchResult }); // => '{"type":"SearchResult"}'
+   * ```
+   */
 
   toJSON() {
     return this.toString();
@@ -888,25 +2614,32 @@ function defineTypes(config) {
     );
   return types;
 }
+/**
+ * Configuration used to construct a GraphQLUnionType.
+ * @typeParam TSource - Source object type passed to resolvers.
+ * @typeParam TContext - Context object type passed to resolvers.
+ */
 
 /**
  * Enum Type Definition
  *
- * Some leaf values of requests and input values are Enums. GraphQL serializes
- * Enum values as strings, however internally Enums can be represented by any
- * kind of type, often integers.
- *
- * Example:
- *
+ * Enum types define leaf values whose serialized form is one of a fixed set
+ * of GraphQL enum names. Internally, enum values can map to any runtime value,
+ * often integers.
+ * @example
  * ```ts
+ * import { GraphQLEnumType } from 'graphql/type';
+ *
  * const RGBType = new GraphQLEnumType({
  *   name: 'RGB',
  *   values: {
  *     RED: { value: 0 },
  *     GREEN: { value: 1 },
- *     BLUE: { value: 2 }
- *   }
+ *     BLUE: { value: 2 },
+ *   },
  * });
+ *
+ * RGBType.getValue('GREEN')?.value; // => 1
  * ```
  *
  * Note: If a value is not provided in a definition, the name of the enum value
@@ -914,6 +2647,66 @@ function defineTypes(config) {
  */
 export class GraphQLEnumType {
   /* <T> */
+  /** The GraphQL name for this schema element. */
+
+  /** Human-readable description for this schema element, if provided. */
+
+  /** Extension fields to include in the formatted result. */
+
+  /** AST node from which this schema element was built, if available. */
+
+  /** AST extension nodes applied to this schema element. */
+
+  /**
+   * Creates a GraphQLEnumType instance.
+   * @param config - Configuration describing this object.
+   * @example
+   * ```ts
+   * import { parse } from 'graphql/language';
+   * import { GraphQLEnumType } from 'graphql/type';
+   *
+   * const document = parse(`
+   *   enum Episode {
+   *     NEW_HOPE
+   *     EMPIRE
+   *     JEDI
+   *   }
+   *
+   *   extend enum Episode {
+   *     FORCE_AWAKENS
+   *   }
+   * `);
+   * const definition = document.definitions[0];
+   *
+   * const Episode = new GraphQLEnumType({
+   *   name: 'Episode',
+   *   description: 'A Star Wars film episode.',
+   *   values: {
+   *     NEW_HOPE: {
+   *       value: 4,
+   *       description: 'Released in 1977.',
+   *       extensions: { trilogy: 'original' },
+   *       astNode: definition.values[0],
+   *     },
+   *     EMPIRE: { value: 5, astNode: definition.values[1] },
+   *     JEDI: {
+   *       value: 6,
+   *       deprecationReason: 'Use RETURN_OF_THE_JEDI.',
+   *       astNode: definition.values[2],
+   *     },
+   *   },
+   *   extensions: { catalog: 'films' },
+   *   astNode: definition,
+   *   extensionASTNodes: [ document.definitions[1] ],
+   * });
+   *
+   * Episode.description; // => 'A Star Wars film episode.'
+   * Episode.serialize(5); // => 'EMPIRE'
+   * Episode.parseValue('JEDI'); // => 6
+   * Episode.getValue('JEDI').deprecationReason; // => 'Use RETURN_OF_THE_JEDI.'
+   * Episode.extensions; // => { catalog: 'films' }
+   * ```
+   */
   constructor(config) {
     var _config$extensionASTN5;
 
@@ -933,10 +2726,39 @@ export class GraphQLEnumType {
     this._valueLookup = null;
     this._nameLookup = null;
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'GraphQLEnumType';
   }
+  /**
+   * Returns the values defined by this enum type.
+   * @returns Enum value definitions in schema order.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertEnumType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   enum Episode {
+   *     NEW_HOPE
+   *     EMPIRE
+   *     JEDI
+   *   }
+   *
+   *   type Query {
+   *     episode: Episode
+   *   }
+   * `);
+   *
+   * const Episode = assertEnumType(schema.getType('Episode'));
+   *
+   * Episode.getValues().map((value) => value.name); // => ['NEW_HOPE', 'EMPIRE', 'JEDI']
+   * ```
+   */
 
   getValues() {
     if (typeof this._values === 'function') {
@@ -945,6 +2767,32 @@ export class GraphQLEnumType {
 
     return this._values;
   }
+  /**
+   * Returns the enum value definition for a value name.
+   * @param name - The GraphQL name to look up.
+   * @returns The matching enum value definition, if it exists.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertEnumType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   enum Episode {
+   *     NEW_HOPE
+   *     EMPIRE
+   *   }
+   *
+   *   type Query {
+   *     episode: Episode
+   *   }
+   * `);
+   *
+   * const Episode = assertEnumType(schema.getType('Episode'));
+   *
+   * Episode.getValue('EMPIRE')?.name; // => 'EMPIRE'
+   * Episode.getValue('JEDI'); // => undefined
+   * ```
+   */
 
   getValue(name) {
     if (this._nameLookup === null) {
@@ -953,6 +2801,27 @@ export class GraphQLEnumType {
 
     return this._nameLookup[name];
   }
+  /**
+   * Serializes a runtime enum value as a GraphQL enum name.
+   * @param outputValue - Runtime enum value to serialize.
+   * @returns The GraphQL enum name for the runtime value.
+   * @example
+   * ```ts
+   * import { GraphQLEnumType } from 'graphql/type';
+   *
+   * const RGB = new GraphQLEnumType({
+   *   name: 'RGB',
+   *   values: {
+   *     RED: { value: 0 },
+   *     GREEN: { value: 1 },
+   *     BLUE: { value: 2 },
+   *   },
+   * });
+   *
+   * RGB.serialize(1); // => 'GREEN'
+   * RGB.serialize(3); // throws an error
+   * ```
+   */
 
   serialize(outputValue) {
     if (this._valueLookup === null) {
@@ -971,6 +2840,28 @@ export class GraphQLEnumType {
 
     return enumValue.name;
   }
+  /**
+   * Parses a GraphQL enum name from variable input.
+   * @param inputValue - Runtime input value to parse.
+   * @returns The internal enum value represented by the input name.
+   * @example
+   * ```ts
+   * import { GraphQLEnumType } from 'graphql/type';
+   *
+   * const RGB = new GraphQLEnumType({
+   *   name: 'RGB',
+   *   values: {
+   *     RED: { value: 0 },
+   *     GREEN: { value: 1 },
+   *     BLUE: { value: 2 },
+   *   },
+   * });
+   *
+   * RGB.parseValue('BLUE'); // => 2
+   * RGB.parseValue('PURPLE'); // throws an error
+   * RGB.parseValue(2); // throws an error
+   * ```
+   */
 
   parseValue(inputValue) /* T */
   {
@@ -993,6 +2884,29 @@ export class GraphQLEnumType {
 
     return enumValue.value;
   }
+  /**
+   * Parses a GraphQL enum name from an AST value literal.
+   * @param valueNode - AST value literal to parse.
+   * @param _variables - Runtime variable values; ignored because enum literals cannot contain variables.
+   * @returns The internal enum value represented by the literal.
+   * @example
+   * ```ts
+   * import { parseValue } from 'graphql/language';
+   * import { GraphQLEnumType } from 'graphql/type';
+   *
+   * const RGB = new GraphQLEnumType({
+   *   name: 'RGB',
+   *   values: {
+   *     RED: { value: 0 },
+   *     GREEN: { value: 1 },
+   *     BLUE: { value: 2 },
+   *   },
+   * });
+   *
+   * RGB.parseLiteral(parseValue('RED')); // => 0
+   * RGB.parseLiteral(parseValue('"RED"')); // throws an error
+   * ```
+   */
 
   parseLiteral(valueNode, _variables) /* T */
   {
@@ -1023,6 +2937,29 @@ export class GraphQLEnumType {
 
     return enumValue.value;
   }
+  /**
+   * Returns a normalized configuration object for this object.
+   * @returns A configuration object that can be used to recreate this object.
+   * @example
+   * ```ts
+   * import { GraphQLEnumType } from 'graphql/type';
+   *
+   * const RGB = new GraphQLEnumType({
+   *   name: 'RGB',
+   *   values: {
+   *     RED: { value: 0 },
+   *     GREEN: { value: 1 },
+   *     BLUE: { value: 2 },
+   *   },
+   * });
+   *
+   * const config = RGB.toConfig();
+   * const RGBCopy = new GraphQLEnumType(config);
+   *
+   * config.values.GREEN.value; // => 1
+   * RGBCopy.serialize(2); // => 'BLUE'
+   * ```
+   */
 
   toConfig() {
     const values = keyValMap(
@@ -1045,10 +2982,51 @@ export class GraphQLEnumType {
       extensionASTNodes: this.extensionASTNodes,
     };
   }
+  /**
+   * Returns the schema coordinate identifying this enum type.
+   * @returns The schema coordinate for this enum type.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertEnumType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   enum Episode {
+   *     NEW_HOPE
+   *   }
+   *
+   *   type Query {
+   *     episode: Episode
+   *   }
+   * `);
+   *
+   * const Episode = assertEnumType(schema.getType('Episode'));
+   *
+   * Episode.toString(); // => 'Episode'
+   * ```
+   */
 
   toString() {
     return this.name;
   }
+  /**
+   * Returns the JSON representation used when this object is serialized.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { GraphQLEnumType } from 'graphql/type';
+   *
+   * const Episode = new GraphQLEnumType({
+   *   name: 'Episode',
+   *   values: {
+   *     NEW_HOPE: {},
+   *   },
+   * });
+   *
+   * Episode.toJSON(); // => 'Episode'
+   * JSON.stringify({ type: Episode }); // => '{"type":"Episode"}'
+   * ```
+   */
 
   toJSON() {
     return this.toString();
@@ -1084,6 +3062,7 @@ function defineEnumValues(typeName, valueMap) {
     };
   });
 }
+/** Configuration used to construct a GraphQLEnumType. */
 
 /**
  * Input Object Type Definition
@@ -1092,9 +3071,7 @@ function defineEnumValues(typeName, valueMap) {
  * supplied to a field argument.
  *
  * Using `NonNull` will ensure that a value must be provided by the query
- *
- * Example:
- *
+ * @example
  * ```ts
  * const GeoPoint = new GraphQLInputObjectType({
  *   name: 'GeoPoint',
@@ -1107,6 +3084,86 @@ function defineEnumValues(typeName, valueMap) {
  * ```
  */
 export class GraphQLInputObjectType {
+  /** The GraphQL name for this schema element. */
+
+  /** Human-readable description for this schema element, if provided. */
+
+  /** Extension fields to include in the formatted result. */
+
+  /** AST node from which this schema element was built, if available. */
+
+  /** AST extension nodes applied to this schema element. */
+
+  /** Whether this input object uses the experimental OneOf input object semantics. */
+
+  /**
+   * Creates a GraphQLInputObjectType instance.
+   * @param config - Configuration describing this object.
+   * @example
+   * ```ts
+   * import { parse } from 'graphql/language';
+   * import {
+   *   GraphQLID,
+   *   GraphQLInputObjectType,
+   *   GraphQLInt,
+   *   GraphQLNonNull,
+   *   GraphQLString,
+   * } from 'graphql/type';
+   *
+   * const document = parse(`
+   *   input ReviewInput {
+   *     stars: Int!
+   *     commentary: String
+   *   }
+   *
+   *   extend input ReviewInput {
+   *     body: String
+   *   }
+   * `);
+   * const definition = document.definitions[0];
+   *
+   * const ReviewInput = new GraphQLInputObjectType({
+   *   name: 'ReviewInput',
+   *   description: 'Input collected when reviewing a product.',
+   *   fields: {
+   *     stars: {
+   *       description: 'Star rating from one to five.',
+   *       type: new GraphQLNonNull(GraphQLInt),
+   *       extensions: { min: 1, max: 5 },
+   *       astNode: definition.fields[0],
+   *     },
+   *     commentary: {
+   *       type: GraphQLString,
+   *       defaultValue: '',
+   *       deprecationReason: 'Use body.',
+   *       astNode: definition.fields[1],
+   *     },
+   *   },
+   *   extensions: { form: 'review' },
+   *   astNode: definition,
+   *   extensionASTNodes: [ document.definitions[1] ],
+   *   isOneOf: false,
+   * });
+   * const SearchBy = new GraphQLInputObjectType({
+   *   name: 'SearchBy',
+   *   fields: {
+   *     id: { type: GraphQLID },
+   *     slug: { type: GraphQLString },
+   *   },
+   *   isOneOf: true,
+   * });
+   *
+   * const fields = ReviewInput.getFields();
+   *
+   * ReviewInput.description; // => 'Input collected when reviewing a product.'
+   * String(fields.stars.type); // => 'Int!'
+   * fields.stars.extensions; // => { min: 1, max: 5 }
+   * fields.commentary.defaultValue; // => ''
+   * fields.commentary.deprecationReason; // => 'Use body.'
+   * ReviewInput.isOneOf; // => false
+   * SearchBy.isOneOf; // => true
+   * ```
+   */
   constructor(config) {
     var _config$extensionASTN6, _config$isOneOf;
 
@@ -1125,10 +3182,40 @@ export class GraphQLInputObjectType {
         : false;
     this._fields = defineInputFieldMap.bind(undefined, config);
   }
+  /**
+   * Returns the value used by `Object.prototype.toString`.
+   * @returns The built-in string tag for this object.
+   */
 
   get [Symbol.toStringTag]() {
     return 'GraphQLInputObjectType';
   }
+  /**
+   * Returns the fields defined by this type.
+   * @returns The fields keyed by field name.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertInputObjectType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   input ReviewInput {
+   *     stars: Int!
+   *     commentary: String = ""
+   *   }
+   *
+   *   type Query {
+   *     reviews(filter: ReviewInput): [String]
+   *   }
+   * `);
+   *
+   * const ReviewInput = assertInputObjectType(schema.getType('ReviewInput'));
+   * const fields = ReviewInput.getFields();
+   *
+   * Object.keys(fields); // => ['stars', 'commentary']
+   * fields.commentary.defaultValue; // => ''
+   * ```
+   */
 
   getFields() {
     if (typeof this._fields === 'function') {
@@ -1137,6 +3224,31 @@ export class GraphQLInputObjectType {
 
     return this._fields;
   }
+  /**
+   * Returns a normalized configuration object for this object.
+   * @returns A configuration object that can be used to recreate this object.
+   * @example
+   * ```ts
+   * import {
+   *   GraphQLInputObjectType,
+   *   GraphQLInt,
+   *   GraphQLNonNull,
+   * } from 'graphql/type';
+   *
+   * const ReviewInput = new GraphQLInputObjectType({
+   *   name: 'ReviewInput',
+   *   fields: {
+   *     stars: { type: new GraphQLNonNull(GraphQLInt) },
+   *   },
+   * });
+   *
+   * const config = ReviewInput.toConfig();
+   * const ReviewInputCopy = new GraphQLInputObjectType(config);
+   *
+   * String(config.fields.stars.type); // => 'Int!'
+   * String(ReviewInputCopy.getFields().stars.type); // => 'Int!'
+   * ```
+   */
 
   toConfig() {
     const fields = mapValue(this.getFields(), (field) => ({
@@ -1157,10 +3269,51 @@ export class GraphQLInputObjectType {
       isOneOf: this.isOneOf,
     };
   }
+  /**
+   * Returns the schema coordinate identifying this input object type.
+   * @returns The schema coordinate for this input object type.
+   * @example
+   * ```ts
+   * import { buildSchema } from 'graphql/utilities';
+   * import { assertInputObjectType } from 'graphql/type';
+   *
+   * const schema = buildSchema(`
+   *   input ReviewInput {
+   *     stars: Int!
+   *   }
+   *
+   *   type Query {
+   *     reviews(filter: ReviewInput): [String]
+   *   }
+   * `);
+   *
+   * const ReviewInput = assertInputObjectType(schema.getType('ReviewInput'));
+   *
+   * ReviewInput.toString(); // => 'ReviewInput'
+   * ```
+   */
 
   toString() {
     return this.name;
   }
+  /**
+   * Returns the JSON representation used when this object is serialized.
+   * @returns The JSON-serializable representation.
+   * @example
+   * ```ts
+   * import { GraphQLInputObjectType, GraphQLString } from 'graphql/type';
+   *
+   * const ReviewInput = new GraphQLInputObjectType({
+   *   name: 'ReviewInput',
+   *   fields: {
+   *     commentary: { type: GraphQLString },
+   *   },
+   * });
+   *
+   * ReviewInput.toJSON(); // => 'ReviewInput'
+   * JSON.stringify({ type: ReviewInput }); // => '{"type":"ReviewInput"}'
+   * ```
+   */
 
   toJSON() {
     return this.toString();
@@ -1191,7 +3344,35 @@ function defineInputFieldMap(config) {
     };
   });
 }
+/** Configuration used to construct a GraphQLInputObjectType. */
 
+/**
+ * Returns true when the input field is non-null and has no default value.
+ * @param field - The input field definition to inspect.
+ * @returns True when the input field is non-null and has no default value.
+ * @example
+ * ```ts
+ * import {
+ *   GraphQLInt,
+ *   GraphQLNonNull,
+ *   GraphQLString,
+ *   isRequiredInputField,
+ * } from 'graphql/type';
+ *
+ * const requiredField = { name: 'id', type: new GraphQLNonNull(GraphQLInt) };
+ * const optionalField = { name: 'name', type: GraphQLString };
+ * const fieldWithDefault = {
+ *   name: 'limit',
+ *   type: new GraphQLNonNull(GraphQLInt),
+ *   defaultValue: 10,
+ * };
+ *
+ * isRequiredInputField(requiredField); // => true
+ * isRequiredInputField(optionalField); // => false
+ * isRequiredInputField(fieldWithDefault); // => false
+ * ```
+ */
 export function isRequiredInputField(field) {
   return isNonNullType(field.type) && field.defaultValue === undefined;
 }
+/** A map of input field names to resolved input field definitions. */