graphql 16.14.0 → 16.14.1

package/type/scalars.js

@@ -26,18 +26,22 @@ var _printer = require('../language/printer.js');
 
 var _definition = require('./definition.js');
 
+/** @category Scalars */
+
 /**
  * Maximum possible Int value as per GraphQL Spec (32-bit signed integer).
  * n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe up-to 2^53 - 1
- * */
+ */
 const GRAPHQL_MAX_INT = 2147483647;
 /**
  * Minimum possible Int value as per GraphQL Spec (32-bit signed integer).
  * n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe starting at -(2^53 - 1)
- * */
+ */
 
 exports.GRAPHQL_MAX_INT = GRAPHQL_MAX_INT;
 const GRAPHQL_MIN_INT = -2147483648;
+/** The built-in `Int` scalar type. */
+
 exports.GRAPHQL_MIN_INT = GRAPHQL_MIN_INT;
 const GraphQLInt = new _definition.GraphQLScalarType({
   name: 'Int',
@@ -119,6 +123,8 @@ const GraphQLInt = new _definition.GraphQLScalarType({
     return num;
   },
 });
+/** The built-in `Float` scalar type. */
+
 exports.GraphQLInt = GraphQLInt;
 const GraphQLFloat = new _definition.GraphQLScalarType({
   name: 'Float',
@@ -177,6 +183,8 @@ const GraphQLFloat = new _definition.GraphQLScalarType({
     return parseFloat(valueNode.value);
   },
 });
+/** The built-in `String` scalar type. */
+
 exports.GraphQLFloat = GraphQLFloat;
 const GraphQLString = new _definition.GraphQLScalarType({
   name: 'String',
@@ -231,6 +239,8 @@ const GraphQLString = new _definition.GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** The built-in `Boolean` scalar type. */
+
 exports.GraphQLString = GraphQLString;
 const GraphQLBoolean = new _definition.GraphQLScalarType({
   name: 'Boolean',
@@ -281,6 +291,8 @@ const GraphQLBoolean = new _definition.GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** The built-in `ID` scalar type. */
+
 exports.GraphQLBoolean = GraphQLBoolean;
 const GraphQLID = new _definition.GraphQLScalarType({
   name: 'ID',
@@ -334,6 +346,8 @@ const GraphQLID = new _definition.GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** All built-in scalar types defined by the GraphQL specification. */
+
 exports.GraphQLID = GraphQLID;
 const specifiedScalarTypes = Object.freeze([
   GraphQLString,
@@ -342,6 +356,27 @@ const specifiedScalarTypes = Object.freeze([
   GraphQLBoolean,
   GraphQLID,
 ]);
+/**
+ * Returns true when the scalar type is one of the scalars specified by GraphQL.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the scalar type is one of the scalars specified by GraphQL.
+ * @example
+ * ```ts
+ * import {
+ *   GraphQLScalarType,
+ *   GraphQLString,
+ *   isSpecifiedScalarType,
+ * } from 'graphql/type';
+ *
+ * const DateTime = new GraphQLScalarType({
+ *   name: 'DateTime',
+ * });
+ *
+ * isSpecifiedScalarType(GraphQLString); // => true
+ * isSpecifiedScalarType(DateTime); // => false
+ * ```
+ */
+
 exports.specifiedScalarTypes = specifiedScalarTypes;
 
 function isSpecifiedScalarType(type) {

package/type/scalars.mjs

@@ -1,3 +1,4 @@
+/** @category Scalars */
 import { inspect } from '../jsutils/inspect.mjs';
 import { isObjectLike } from '../jsutils/isObjectLike.mjs';
 import { GraphQLError } from '../error/GraphQLError.mjs';
@@ -7,15 +8,17 @@ import { GraphQLScalarType } from './definition.mjs';
 /**
  * Maximum possible Int value as per GraphQL Spec (32-bit signed integer).
  * n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe up-to 2^53 - 1
- * */
+ */
 
 export const GRAPHQL_MAX_INT = 2147483647;
 /**
  * Minimum possible Int value as per GraphQL Spec (32-bit signed integer).
  * n.b. This differs from JavaScript's numbers that are IEEE 754 doubles safe starting at -(2^53 - 1)
- * */
+ */
 
 export const GRAPHQL_MIN_INT = -2147483648;
+/** The built-in `Int` scalar type. */
+
 export const GraphQLInt = new GraphQLScalarType({
   name: 'Int',
   description:
@@ -90,6 +93,8 @@ export const GraphQLInt = new GraphQLScalarType({
     return num;
   },
 });
+/** The built-in `Float` scalar type. */
+
 export const GraphQLFloat = new GraphQLScalarType({
   name: 'Float',
   description:
@@ -138,6 +143,8 @@ export const GraphQLFloat = new GraphQLScalarType({
     return parseFloat(valueNode.value);
   },
 });
+/** The built-in `String` scalar type. */
+
 export const GraphQLString = new GraphQLScalarType({
   name: 'String',
   description:
@@ -187,6 +194,8 @@ export const GraphQLString = new GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** The built-in `Boolean` scalar type. */
+
 export const GraphQLBoolean = new GraphQLScalarType({
   name: 'Boolean',
   description: 'The `Boolean` scalar type represents `true` or `false`.',
@@ -230,6 +239,8 @@ export const GraphQLBoolean = new GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** The built-in `ID` scalar type. */
+
 export const GraphQLID = new GraphQLScalarType({
   name: 'ID',
   description:
@@ -277,6 +288,8 @@ export const GraphQLID = new GraphQLScalarType({
     return valueNode.value;
   },
 });
+/** All built-in scalar types defined by the GraphQL specification. */
+
 export const specifiedScalarTypes = Object.freeze([
   GraphQLString,
   GraphQLInt,
@@ -284,6 +297,27 @@ export const specifiedScalarTypes = Object.freeze([
   GraphQLBoolean,
   GraphQLID,
 ]);
+/**
+ * Returns true when the scalar type is one of the scalars specified by GraphQL.
+ * @param type - The GraphQL type to inspect.
+ * @returns True when the scalar type is one of the scalars specified by GraphQL.
+ * @example
+ * ```ts
+ * import {
+ *   GraphQLScalarType,
+ *   GraphQLString,
+ *   isSpecifiedScalarType,
+ * } from 'graphql/type';
+ *
+ * const DateTime = new GraphQLScalarType({
+ *   name: 'DateTime',
+ * });
+ *
+ * isSpecifiedScalarType(GraphQLString); // => true
+ * isSpecifiedScalarType(DateTime); // => false
+ * ```
+ */
+
 export function isSpecifiedScalarType(type) {
   return specifiedScalarTypes.some(({ name }) => type.name === name);
 } // Support serializing objects with custom valueOf() or toJSON() functions -