graphql 17.0.0-rc.0 → 17.0.0

package/type/definition.d.mts

@@ -407,7 +407,9 @@ export declare function assertEnumType(type: unknown): GraphQLEnumType;
  * import { buildSchema } from 'graphql/utilities';
  * import { assertEnumType, isEnumValue } from 'graphql/type';
  *
- * const schema = buildSchema('enum Episode { NEW_HOPE } type Query { episode: Episode }');
+ * const schema = buildSchema(
+ *   'enum Episode { NEW_HOPE } type Query { episode: Episode }',
+ * );
  * const enumValue = assertEnumType(schema.getType('Episode')).getValues()[0];
  *
  * isEnumValue(enumValue); // => true
@@ -424,7 +426,9 @@ export declare function isEnumValue(value: unknown): value is GraphQLEnumValue;
  * import { buildSchema } from 'graphql/utilities';
  * import { assertEnumType, assertEnumValue } from 'graphql/type';
  *
- * const schema = buildSchema('enum Episode { NEW_HOPE } type Query { episode: Episode }');
+ * const schema = buildSchema(
+ *   'enum Episode { NEW_HOPE } type Query { episode: Episode }',
+ * );
  * const enumValue = assertEnumValue(
  *   assertEnumType(schema.getType('Episode')).getValues()[0],
  * );
@@ -501,8 +505,12 @@ export declare function assertInputObjectType(type: unknown): GraphQLInputObject
  * import { buildSchema } from 'graphql/utilities';
  * import { assertInputObjectType, isInputField } from 'graphql/type';
  *
- * const schema = buildSchema('input ReviewInput { stars: Int } type Query { ok: Boolean }');
- * const inputField = assertInputObjectType(schema.getType('ReviewInput')).getFields().stars;
+ * const schema = buildSchema(
+ *   'input ReviewInput { stars: Int } type Query { ok: Boolean }',
+ * );
+ * const inputField = assertInputObjectType(
+ *   schema.getType('ReviewInput'),
+ * ).getFields().stars;
  *
  * isInputField(inputField); // => true
  * isInputField(schema.getQueryType()); // => false
@@ -518,7 +526,9 @@ export declare function isInputField(field: unknown): field is GraphQLInputField
  * import { buildSchema } from 'graphql/utilities';
  * import { assertInputField, assertInputObjectType } from 'graphql/type';
  *
- * const schema = buildSchema('input ReviewInput { stars: Int } type Query { ok: Boolean }');
+ * const schema = buildSchema(
+ *   'input ReviewInput { stars: Int } type Query { ok: Boolean }',
+ * );
  * const inputField = assertInputField(
  *   assertInputObjectType(schema.getType('ReviewInput')).getFields().stars,
  * );
@@ -1006,8 +1016,8 @@ export declare function assertAbstractType(type: unknown): GraphQLAbstractType;
  *   fields: () => ({
  *     parents: { type: new GraphQLList(PersonType) },
  *     children: { type: new GraphQLList(PersonType) },
- *   })
- * })
+ *   }),
+ * });
  * ```
  */
 export declare class GraphQLList<T extends GraphQLType> implements GraphQLSchemaElement {
@@ -1078,8 +1088,8 @@ export declare class GraphQLList<T extends GraphQLType> implements GraphQLSchema
  *   name: 'Row',
  *   fields: () => ({
  *     id: { type: new GraphQLNonNull(GraphQLString) },
- *   })
- * })
+ *   }),
+ * });
  * ```
  *
  * Note: the enforcement of non-nullability occurs within the executor.
@@ -1115,9 +1125,7 @@ export declare class GraphQLNonNull<T extends GraphQLNullableType> implements Gr
      * import { GraphQLList, GraphQLNonNull, GraphQLString } from 'graphql/type';
      *
      * const requiredString = new GraphQLNonNull(GraphQLString);
-     * const requiredStringList = new GraphQLNonNull(
-     *   new GraphQLList(GraphQLString),
-     * );
+     * const requiredStringList = new GraphQLNonNull(new GraphQLList(GraphQLString));
      *
      * requiredString.toString(); // => 'String!'
      * requiredStringList.toString(); // => '[String]!'
@@ -1258,9 +1266,7 @@ export declare function getNullableType<T extends GraphQLNullableType>(type: T |
  *   getNullableType,
  * } from 'graphql/type';
  *
- * const requiredStringList = new GraphQLNonNull(
- *   new GraphQLList(GraphQLString),
- * );
+ * const requiredStringList = new GraphQLNonNull(new GraphQLList(GraphQLString));
  *
  * getNullableType(requiredStringList).toString(); // => '[String]'
  * getNullableType(GraphQLString); // => GraphQLString
@@ -1392,11 +1398,7 @@ export declare function getNamedType(type: GraphQLType): GraphQLNamedType;
  * @returns The named type after unwrapping all wrappers, or undefined for nullish input.
  * @example
  * ```ts
- * import {
- *   GraphQLList,
- *   GraphQLString,
- *   getNamedType,
- * } from 'graphql/type';
+ * import { GraphQLList, GraphQLString, getNamedType } from 'graphql/type';
  *
  * getNamedType(new GraphQLList(GraphQLString)); // => GraphQLString
  * getNamedType(undefined); // => undefined
@@ -1527,7 +1529,9 @@ export interface GraphQLScalarTypeExtensions {
  *   }
  *
  *   if (value % 2 === 0) {
- *     throw new Error(`Scalar "Odd" cannot represent "${value}" since it is even.`);
+ *     throw new Error(
+ *       `Scalar "Odd" cannot represent "${value}" since it is even.`,
+ *     );
  *   }
  *
  *   return value;
@@ -1543,7 +1547,7 @@ export interface GraphQLScalarTypeExtensions {
  *   },
  *   valueToLiteral: (value) => {
  *     return { kind: Kind.INT, value: String(ensureOdd(value)) };
- *   }
+ *   },
  * });
  * ```
  */
@@ -1580,7 +1584,7 @@ export declare class GraphQLScalarType<TInternal = unknown, TExternal = TInterna
     coerceInputLiteral: GraphQLScalarInputLiteralCoercer<TInternal> | undefined;
     /** Converter used to produce GraphQL literals from runtime input values. */
     valueToLiteral: GraphQLScalarValueToLiteral | undefined;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions: Readonly<GraphQLScalarTypeExtensions>;
     /** AST node from which this schema element was built, if available. */
     astNode: Maybe<ScalarTypeDefinitionNode>;
@@ -1632,7 +1636,7 @@ export declare class GraphQLScalarType<TInternal = unknown, TExternal = TInterna
      *   },
      *   extensions: { numeric: true },
      *   astNode: document.definitions[0],
-     *   extensionASTNodes: [ document.definitions[1] ],
+     *   extensionASTNodes: [document.definitions[1]],
      * });
      *
      * Odd.description; // => 'Odd integer values.'
@@ -1775,7 +1779,7 @@ export interface GraphQLScalarTypeConfig<TInternal, TExternal> {
     coerceInputLiteral?: GraphQLScalarInputLiteralCoercer<TInternal> | undefined;
     /** Translates an externally provided value to a literal (AST). */
     valueToLiteral?: GraphQLScalarValueToLiteral | undefined;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions?: Maybe<Readonly<GraphQLScalarTypeExtensions>>;
     /** AST node from which this schema element was built, if available. */
     astNode?: Maybe<ScalarTypeDefinitionNode>;
@@ -1826,10 +1830,10 @@ export interface GraphQLObjectTypeExtensions<_TSource = any, _TContext = any> {
  *     formatted: {
  *       type: GraphQLString,
  *       resolve: (obj) => {
- *         return obj.number + ' ' + obj.street
- *       }
- *     }
- *   }
+ *         return obj.number + ' ' + obj.street;
+ *       },
+ *     },
+ *   },
  * });
  * ```
  * @example
@@ -1843,7 +1847,7 @@ export interface GraphQLObjectTypeExtensions<_TSource = any, _TContext = any> {
  *   fields: () => ({
  *     name: { type: GraphQLString },
  *     bestFriend: { type: PersonType },
- *   })
+ *   }),
  * });
  * ```
  */
@@ -1854,7 +1858,7 @@ export declare class GraphQLObjectType<TSource = any, TContext = any, TAbstract
     description: Maybe<string>;
     /** Predicate used to determine whether a runtime value belongs to this object type. */
     isTypeOf: Maybe<GraphQLIsTypeOfFn<TAbstract, TContext>>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions: Readonly<GraphQLObjectTypeExtensions<TSource, TContext>>;
     /** AST node from which this schema element was built, if available. */
     astNode: Maybe<ObjectTypeDefinitionNode>;
@@ -1930,7 +1934,7 @@ export declare class GraphQLObjectType<TSource = any, TContext = any, TAbstract
      *   },
      *   extensions: { entity: 'User' },
      *   astNode: definition,
-     *   extensionASTNodes: [ document.definitions[1] ],
+     *   extensionASTNodes: [document.definitions[1]],
      * });
      *
      * User.name; // => 'User'
@@ -2104,7 +2108,7 @@ export interface GraphQLObjectTypeConfig<TSource, TContext, TAbstract = unknown>
     fields: ThunkObjMap<GraphQLFieldConfig<TSource, TContext>>;
     /** Predicate used to determine whether a runtime value belongs to this object type. */
     isTypeOf?: Maybe<GraphQLIsTypeOfFn<TAbstract, TContext>>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions?: Maybe<Readonly<GraphQLObjectTypeExtensions<TSource, TContext>>>;
     /** AST node from which this schema element was built, if available. */
     astNode?: Maybe<ObjectTypeDefinitionNode>;
@@ -2231,7 +2235,7 @@ export interface GraphQLFieldConfig<TSource, TContext, TArgs = any> {
     subscribe?: GraphQLFieldResolver<TSource, TContext, TArgs> | undefined;
     /** Reason this element is deprecated, if one was provided. */
     deprecationReason?: Maybe<string>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions?: Maybe<Readonly<GraphQLFieldExtensions<TSource, TContext, TArgs>>>;
     /** AST node from which this schema element was built, if available. */
     astNode?: Maybe<FieldDefinitionNode>;
@@ -2271,7 +2275,7 @@ export interface GraphQLArgumentConfig {
     default?: GraphQLDefaultInput | undefined;
     /** Reason this element is deprecated, if one was provided. */
     deprecationReason?: Maybe<string>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions?: Maybe<Readonly<GraphQLArgumentExtensions>>;
     /** AST node from which this schema element was built, if available. */
     astNode?: Maybe<InputValueDefinitionNode>;
@@ -2312,7 +2316,7 @@ export declare class GraphQLField<TSource = any, TContext = any, TArgs = any> im
     subscribe?: GraphQLFieldResolver<TSource, TContext, TArgs> | undefined;
     /** Reason this element is deprecated, if one was provided. */
     deprecationReason: Maybe<string>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions: Readonly<GraphQLFieldExtensions<TSource, TContext, TArgs>>;
     /** AST node from which this schema element was built, if available. */
     astNode: Maybe<FieldDefinitionNode>;
@@ -2425,7 +2429,7 @@ export declare class GraphQLArgument implements GraphQLSchemaElement {
     default: GraphQLDefaultInput | undefined;
     /** Reason this element is deprecated, if one was provided. */
     deprecationReason: Maybe<string>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions: Readonly<GraphQLArgumentExtensions>;
     /** AST node from which this schema element was built, if available. */
     astNode: Maybe<InputValueDefinitionNode>;
@@ -2603,8 +2607,8 @@ export interface GraphQLInterfaceTypeExtensions {
  * const EntityType = new GraphQLInterfaceType({
  *   name: 'Entity',
  *   fields: {
- *     name: { type: GraphQLString }
- *   }
+ *     name: { type: GraphQLString },
+ *   },
  * });
  * ```
  */
@@ -2615,7 +2619,7 @@ export declare class GraphQLInterfaceType<TSource = any, TContext = any> impleme
     description: Maybe<string>;
     /** Function that resolves the concrete object type for this abstract type. */
     resolveType: Maybe<GraphQLTypeResolver<TSource, TContext>>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions: Readonly<GraphQLInterfaceTypeExtensions>;
     /** AST node from which this schema element was built, if available. */
     astNode: Maybe<InterfaceTypeDefinitionNode>;
@@ -2666,7 +2670,7 @@ export declare class GraphQLInterfaceType<TSource = any, TContext = any> impleme
      *   },
      *   extensions: { abstract: true },
      *   astNode: document.definitions[1],
-     *   extensionASTNodes: [ document.definitions[2] ],
+     *   extensionASTNodes: [document.definitions[2]],
      * });
      *
      * Resource.name; // => 'Resource'
@@ -2833,7 +2837,7 @@ export interface GraphQLInterfaceTypeConfig<TSource, TContext> {
      * Object type.
      */
     resolveType?: Maybe<GraphQLTypeResolver<TSource, TContext>>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions?: Maybe<Readonly<GraphQLInterfaceTypeExtensions>>;
     /** AST node from which this schema element was built, if available. */
     astNode?: Maybe<InterfaceTypeDefinitionNode>;
@@ -2878,7 +2882,7 @@ export interface GraphQLUnionTypeExtensions {
  *     if (value instanceof Cat) {
  *       return CatType;
  *     }
- *   }
+ *   },
  * });
  * ```
  */
@@ -2889,7 +2893,7 @@ export declare class GraphQLUnionType<TSource = any, TContext = any> implements
     description: Maybe<string>;
     /** Function that resolves the concrete object type for this abstract type. */
     resolveType: Maybe<GraphQLTypeResolver<TSource, TContext>>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions: Readonly<GraphQLUnionTypeExtensions>;
     /** AST node from which this schema element was built, if available. */
     astNode: Maybe<UnionTypeDefinitionNode>;
@@ -2902,7 +2906,11 @@ export declare class GraphQLUnionType<TSource = any, TContext = any> implements
      * @example
      * ```ts
      * import { parse } from 'graphql/language';
-     * import { GraphQLObjectType, GraphQLString, GraphQLUnionType } from 'graphql/type';
+     * import {
+     *   GraphQLObjectType,
+     *   GraphQLString,
+     *   GraphQLUnionType,
+     * } from 'graphql/type';
      *
      * const document = parse(`
      *   union Media = Photo | Video
@@ -2930,7 +2938,7 @@ export declare class GraphQLUnionType<TSource = any, TContext = any> implements
      *   },
      *   extensions: { searchable: true },
      *   astNode: document.definitions[0],
-     *   extensionASTNodes: [ document.definitions[1] ],
+     *   extensionASTNodes: [document.definitions[1]],
      * });
      *
      * Media.description; // => 'Media that can appear in a search result.'
@@ -2979,7 +2987,11 @@ export declare class GraphQLUnionType<TSource = any, TContext = any> implements
      * @returns A configuration object that can be used to recreate this object.
      * @example
      * ```ts
-     * import { GraphQLObjectType, GraphQLString, GraphQLUnionType } from 'graphql/type';
+     * import {
+     *   GraphQLObjectType,
+     *   GraphQLString,
+     *   GraphQLUnionType,
+     * } from 'graphql/type';
      *
      * const Photo = new GraphQLObjectType({
      *   name: 'Photo',
@@ -3032,7 +3044,11 @@ export declare class GraphQLUnionType<TSource = any, TContext = any> implements
      * @returns The JSON-serializable representation.
      * @example
      * ```ts
-     * import { GraphQLObjectType, GraphQLString, GraphQLUnionType } from 'graphql/type';
+     * import {
+     *   GraphQLObjectType,
+     *   GraphQLString,
+     *   GraphQLUnionType,
+     * } from 'graphql/type';
      *
      * const Photo = new GraphQLObjectType({
      *   name: 'Photo',
@@ -3067,7 +3083,7 @@ export interface GraphQLUnionTypeConfig<TSource, TContext> {
      * Object type.
      */
     resolveType?: Maybe<GraphQLTypeResolver<TSource, TContext>>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions?: Maybe<Readonly<GraphQLUnionTypeExtensions>>;
     /** AST node from which this schema element was built, if available. */
     astNode?: Maybe<UnionTypeDefinitionNode>;
@@ -3121,7 +3137,7 @@ export declare class GraphQLEnumType/* <T> */  implements GraphQLSchemaElement {
     name: string;
     /** Human-readable description for this schema element, if provided. */
     description: Maybe<string>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions: Readonly<GraphQLEnumTypeExtensions>;
     /** AST node from which this schema element was built, if available. */
     astNode: Maybe<EnumTypeDefinitionNode>;
@@ -3170,7 +3186,7 @@ export declare class GraphQLEnumType/* <T> */  implements GraphQLSchemaElement {
      *   },
      *   extensions: { catalog: 'films' },
      *   astNode: definition,
-     *   extensionASTNodes: [ document.definitions[1] ],
+     *   extensionASTNodes: [document.definitions[1]],
      * });
      *
      * Episode.description; // => 'A Star Wars film episode.'
@@ -3486,7 +3502,7 @@ export interface GraphQLEnumTypeConfig {
     description?: Maybe<string>;
     /** Values contained in this enum, list, or input-object definition. */
     values: ThunkObjMap<GraphQLEnumValueConfig>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions?: Maybe<Readonly<GraphQLEnumTypeExtensions>>;
     /** AST node from which this schema element was built, if available. */
     astNode?: Maybe<EnumTypeDefinitionNode>;
@@ -3522,7 +3538,7 @@ export interface GraphQLEnumValueConfig {
     value?: any;
     /** Reason this element is deprecated, if one was provided. */
     deprecationReason?: Maybe<string>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions?: Maybe<Readonly<GraphQLEnumValueExtensions>>;
     /** AST node from which this schema element was built, if available. */
     astNode?: Maybe<EnumValueDefinitionNode>;
@@ -3543,7 +3559,7 @@ export declare class GraphQLEnumValue implements GraphQLSchemaElement {
     value: any;
     /** Reason this element is deprecated, if one was provided. */
     deprecationReason: Maybe<string>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions: Readonly<GraphQLEnumValueExtensions>;
     /** AST node from which this schema element was built, if available. */
     astNode: Maybe<EnumValueDefinitionNode>;
@@ -3657,7 +3673,7 @@ export interface GraphQLInputObjectTypeExtensions {
  *     lat: { type: new GraphQLNonNull(GraphQLFloat) },
  *     lon: { type: new GraphQLNonNull(GraphQLFloat) },
  *     alt: { type: GraphQLFloat, default: { value: 0 } },
- *   }
+ *   },
  * });
  * ```
  */
@@ -3666,7 +3682,7 @@ export declare class GraphQLInputObjectType implements GraphQLSchemaElement {
     name: string;
     /** Human-readable description for this schema element, if provided. */
     description: Maybe<string>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions: Readonly<GraphQLInputObjectTypeExtensions>;
     /** AST node from which this schema element was built, if available. */
     astNode: Maybe<InputObjectTypeDefinitionNode>;
@@ -3720,7 +3736,7 @@ export declare class GraphQLInputObjectType implements GraphQLSchemaElement {
      *   },
      *   extensions: { form: 'review' },
      *   astNode: definition,
-     *   extensionASTNodes: [ document.definitions[1] ],
+     *   extensionASTNodes: [document.definitions[1]],
      *   isOneOf: false,
      * });
      * const SearchBy = new GraphQLInputObjectType({
@@ -3854,7 +3870,7 @@ export interface GraphQLInputObjectTypeConfig {
     description?: Maybe<string>;
     /** Fields declared by this object, interface, input object, or literal. */
     fields: ThunkObjMap<GraphQLInputFieldConfig>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions?: Maybe<Readonly<GraphQLInputObjectTypeExtensions>>;
     /** AST node from which this schema element was built, if available. */
     astNode?: Maybe<InputObjectTypeDefinitionNode>;
@@ -3896,7 +3912,7 @@ export interface GraphQLInputFieldConfig {
     default?: GraphQLDefaultInput | undefined;
     /** Reason this element is deprecated, if one was provided. */
     deprecationReason?: Maybe<string>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions?: Maybe<Readonly<GraphQLInputFieldExtensions>>;
     /** AST node from which this schema element was built, if available. */
     astNode?: Maybe<InputValueDefinitionNode>;
@@ -3930,7 +3946,7 @@ export declare class GraphQLInputField implements GraphQLSchemaElement {
     default: GraphQLDefaultInput | undefined;
     /** Reason this element is deprecated, if one was provided. */
     deprecationReason: Maybe<string>;
-    /** Extension fields to include in the formatted result. */
+    /** Custom extension fields reserved for users. */
     extensions: Readonly<GraphQLInputFieldExtensions>;
     /** AST node from which this schema element was built, if available. */
     astNode: Maybe<InputValueDefinitionNode>;
@@ -3941,7 +3957,11 @@ export declare class GraphQLInputField implements GraphQLSchemaElement {
      * @param config - Input field configuration.
      * @example
      * ```ts
-     * import { GraphQLInputField, GraphQLInputObjectType, GraphQLString } from 'graphql/type';
+     * import {
+     *   GraphQLInputField,
+     *   GraphQLInputObjectType,
+     *   GraphQLString,
+     * } from 'graphql/type';
      *
      * const ReviewInput = new GraphQLInputObjectType({
      *   name: 'ReviewInput',
@@ -3968,7 +3988,11 @@ export declare class GraphQLInputField implements GraphQLSchemaElement {
      * @returns A configuration object that can be used to recreate this input field.
      * @example
      * ```ts
-     * import { GraphQLInputField, GraphQLInputObjectType, GraphQLString } from 'graphql/type';
+     * import {
+     *   GraphQLInputField,
+     *   GraphQLInputObjectType,
+     *   GraphQLString,
+     * } from 'graphql/type';
      *
      * const ReviewInput = new GraphQLInputObjectType({
      *   name: 'ReviewInput',
@@ -3988,7 +4012,11 @@ export declare class GraphQLInputField implements GraphQLSchemaElement {
      * @returns The input field coordinate.
      * @example
      * ```ts
-     * import { GraphQLInputField, GraphQLInputObjectType, GraphQLString } from 'graphql/type';
+     * import {
+     *   GraphQLInputField,
+     *   GraphQLInputObjectType,
+     *   GraphQLString,
+     * } from 'graphql/type';
      *
      * const ReviewInput = new GraphQLInputObjectType({
      *   name: 'ReviewInput',
@@ -4007,7 +4035,11 @@ export declare class GraphQLInputField implements GraphQLSchemaElement {
      * @returns The input field coordinate.
      * @example
      * ```ts
-     * import { GraphQLInputField, GraphQLInputObjectType, GraphQLString } from 'graphql/type';
+     * import {
+     *   GraphQLInputField,
+     *   GraphQLInputObjectType,
+     *   GraphQLString,
+     * } from 'graphql/type';
      *
      * const ReviewInput = new GraphQLInputObjectType({
      *   name: 'ReviewInput',