graphql 16.14.0 → 16.14.1

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (371) hide show
  1. package/error/GraphQLError.d.ts +151 -15
  2. package/error/GraphQLError.js +143 -12
  3. package/error/GraphQLError.mjs +143 -12
  4. package/error/index.d.ts +6 -0
  5. package/error/index.mjs +6 -0
  6. package/error/locatedError.d.ts +20 -0
  7. package/error/locatedError.js +21 -0
  8. package/error/locatedError.mjs +20 -0
  9. package/error/syntaxError.d.ts +15 -0
  10. package/error/syntaxError.js +16 -0
  11. package/error/syntaxError.mjs +15 -0
  12. package/execution/collectFields.js +6 -0
  13. package/execution/collectFields.mjs +6 -0
  14. package/execution/execute.d.ts +211 -12
  15. package/execution/execute.js +214 -23
  16. package/execution/execute.mjs +213 -23
  17. package/execution/index.d.ts +6 -0
  18. package/execution/index.mjs +6 -0
  19. package/execution/mapAsyncIterator.d.ts +2 -0
  20. package/execution/mapAsyncIterator.js +2 -0
  21. package/execution/mapAsyncIterator.mjs +2 -0
  22. package/execution/subscribe.d.ts +195 -5
  23. package/execution/subscribe.js +154 -11
  24. package/execution/subscribe.mjs +153 -11
  25. package/execution/values.d.ts +167 -10
  26. package/execution/values.js +149 -5
  27. package/execution/values.mjs +148 -5
  28. package/graphql.d.ts +163 -41
  29. package/graphql.js +126 -4
  30. package/graphql.mjs +131 -41
  31. package/index.d.ts +11 -17
  32. package/index.mjs +13 -19
  33. package/jsutils/Maybe.d.ts +5 -1
  34. package/jsutils/ObjMap.d.ts +4 -0
  35. package/jsutils/Path.d.ts +30 -0
  36. package/jsutils/Path.js +29 -0
  37. package/jsutils/Path.mjs +29 -0
  38. package/jsutils/PromiseOrValue.d.ts +1 -0
  39. package/jsutils/devAssert.d.ts +1 -0
  40. package/jsutils/devAssert.js +1 -0
  41. package/jsutils/devAssert.mjs +1 -0
  42. package/jsutils/didYouMean.d.ts +4 -1
  43. package/jsutils/didYouMean.js +4 -1
  44. package/jsutils/didYouMean.mjs +4 -1
  45. package/jsutils/groupBy.d.ts +2 -0
  46. package/jsutils/groupBy.js +2 -0
  47. package/jsutils/groupBy.mjs +2 -0
  48. package/jsutils/identityFunc.d.ts +2 -0
  49. package/jsutils/identityFunc.js +2 -0
  50. package/jsutils/identityFunc.mjs +2 -0
  51. package/jsutils/inspect.d.ts +2 -0
  52. package/jsutils/inspect.js +2 -0
  53. package/jsutils/inspect.mjs +2 -0
  54. package/jsutils/instanceOf.d.ts +2 -0
  55. package/jsutils/instanceOf.js +2 -0
  56. package/jsutils/instanceOf.mjs +2 -0
  57. package/jsutils/invariant.d.ts +1 -0
  58. package/jsutils/invariant.js +1 -0
  59. package/jsutils/invariant.mjs +1 -0
  60. package/jsutils/isAsyncIterable.d.ts +2 -0
  61. package/jsutils/isAsyncIterable.js +2 -0
  62. package/jsutils/isAsyncIterable.mjs +2 -0
  63. package/jsutils/isIterableObject.d.ts +6 -5
  64. package/jsutils/isIterableObject.js +6 -5
  65. package/jsutils/isIterableObject.mjs +6 -5
  66. package/jsutils/isObjectLike.d.ts +2 -0
  67. package/jsutils/isObjectLike.js +2 -0
  68. package/jsutils/isObjectLike.mjs +2 -0
  69. package/jsutils/isPromise.d.ts +2 -0
  70. package/jsutils/isPromise.js +2 -0
  71. package/jsutils/isPromise.mjs +2 -0
  72. package/jsutils/keyMap.d.ts +7 -14
  73. package/jsutils/keyMap.js +7 -14
  74. package/jsutils/keyMap.mjs +7 -14
  75. package/jsutils/keyValMap.d.ts +9 -6
  76. package/jsutils/keyValMap.js +9 -6
  77. package/jsutils/keyValMap.mjs +9 -6
  78. package/jsutils/mapValue.d.ts +2 -0
  79. package/jsutils/mapValue.js +2 -0
  80. package/jsutils/mapValue.mjs +2 -0
  81. package/jsutils/memoize3.d.ts +2 -0
  82. package/jsutils/memoize3.js +2 -0
  83. package/jsutils/memoize3.mjs +2 -0
  84. package/jsutils/naturalCompare.d.ts +2 -0
  85. package/jsutils/naturalCompare.js +2 -0
  86. package/jsutils/naturalCompare.mjs +2 -0
  87. package/jsutils/printPathArray.d.ts +2 -0
  88. package/jsutils/printPathArray.js +2 -0
  89. package/jsutils/printPathArray.mjs +2 -0
  90. package/jsutils/promiseForObject.d.ts +2 -0
  91. package/jsutils/promiseForObject.js +2 -0
  92. package/jsutils/promiseForObject.mjs +2 -0
  93. package/jsutils/promiseReduce.d.ts +2 -0
  94. package/jsutils/promiseReduce.js +2 -0
  95. package/jsutils/promiseReduce.mjs +2 -0
  96. package/jsutils/suggestionList.d.ts +2 -0
  97. package/jsutils/suggestionList.js +4 -0
  98. package/jsutils/suggestionList.mjs +4 -0
  99. package/jsutils/toError.d.ts +2 -0
  100. package/jsutils/toError.js +2 -0
  101. package/jsutils/toError.mjs +2 -0
  102. package/jsutils/toObjMap.d.ts +1 -0
  103. package/jsutils/toObjMap.js +1 -0
  104. package/jsutils/toObjMap.mjs +1 -0
  105. package/language/ast.d.ts +412 -54
  106. package/language/ast.js +95 -38
  107. package/language/ast.mjs +95 -38
  108. package/language/blockString.d.ts +1 -3
  109. package/language/blockString.js +1 -3
  110. package/language/blockString.mjs +1 -3
  111. package/language/directiveLocation.d.ts +28 -8
  112. package/language/directiveLocation.js +9 -6
  113. package/language/directiveLocation.mjs +9 -6
  114. package/language/index.d.ts +6 -0
  115. package/language/index.mjs +6 -0
  116. package/language/kinds.d.ts +57 -18
  117. package/language/kinds.js +9 -6
  118. package/language/kinds.mjs +9 -6
  119. package/language/lexer.d.ts +47 -14
  120. package/language/lexer.js +71 -13
  121. package/language/lexer.mjs +70 -13
  122. package/language/location.d.ts +16 -3
  123. package/language/location.js +14 -3
  124. package/language/location.mjs +14 -3
  125. package/language/parser.d.ts +236 -13
  126. package/language/parser.js +224 -0
  127. package/language/parser.mjs +224 -3
  128. package/language/predicates.d.ts +169 -0
  129. package/language/predicates.js +170 -0
  130. package/language/predicates.mjs +180 -0
  131. package/language/printLocation.d.ts +28 -0
  132. package/language/printLocation.js +29 -0
  133. package/language/printLocation.mjs +28 -0
  134. package/language/printString.d.ts +2 -0
  135. package/language/printString.js +5 -1
  136. package/language/printString.mjs +5 -1
  137. package/language/printer.d.ts +12 -0
  138. package/language/printer.js +19 -0
  139. package/language/printer.mjs +18 -0
  140. package/language/schemaCoordinateLexer.d.ts +8 -6
  141. package/language/schemaCoordinateLexer.js +10 -6
  142. package/language/schemaCoordinateLexer.mjs +10 -6
  143. package/language/source.d.ts +28 -0
  144. package/language/source.js +32 -0
  145. package/language/source.mjs +31 -0
  146. package/language/tokenKind.d.ts +30 -3
  147. package/language/tokenKind.js +8 -3
  148. package/language/tokenKind.mjs +8 -3
  149. package/language/visitor.d.ts +200 -72
  150. package/language/visitor.js +122 -50
  151. package/language/visitor.mjs +122 -54
  152. package/package.json +1 -1
  153. package/subscription/index.d.ts +9 -3
  154. package/subscription/index.mjs +9 -3
  155. package/type/assertName.d.ts +18 -1
  156. package/type/assertName.js +19 -1
  157. package/type/assertName.mjs +18 -1
  158. package/type/definition.d.ts +2540 -79
  159. package/type/definition.js +2214 -61
  160. package/type/definition.mjs +2241 -60
  161. package/type/directives.d.ts +193 -18
  162. package/type/directives.js +196 -19
  163. package/type/directives.mjs +196 -19
  164. package/type/index.d.ts +6 -0
  165. package/type/index.mjs +6 -0
  166. package/type/introspection.d.ts +36 -0
  167. package/type/introspection.js +33 -0
  168. package/type/introspection.mjs +41 -0
  169. package/type/scalars.d.ts +29 -2
  170. package/type/scalars.js +37 -2
  171. package/type/scalars.mjs +36 -2
  172. package/type/schema.d.ts +490 -28
  173. package/type/schema.js +484 -26
  174. package/type/schema.mjs +484 -26
  175. package/type/validate.d.ts +31 -0
  176. package/type/validate.js +32 -0
  177. package/type/validate.mjs +31 -0
  178. package/utilities/TypeInfo.d.ts +441 -1
  179. package/utilities/TypeInfo.js +444 -1
  180. package/utilities/TypeInfo.mjs +443 -1
  181. package/utilities/assertValidName.d.ts +27 -2
  182. package/utilities/assertValidName.js +28 -2
  183. package/utilities/assertValidName.mjs +27 -2
  184. package/utilities/astFromValue.d.ts +33 -3
  185. package/utilities/astFromValue.js +36 -3
  186. package/utilities/astFromValue.mjs +35 -3
  187. package/utilities/buildASTSchema.d.ts +65 -6
  188. package/utilities/buildASTSchema.js +65 -6
  189. package/utilities/buildASTSchema.mjs +65 -6
  190. package/utilities/buildClientSchema.d.ts +15 -0
  191. package/utilities/buildClientSchema.js +16 -0
  192. package/utilities/buildClientSchema.mjs +15 -0
  193. package/utilities/coerceInputValue.d.ts +46 -0
  194. package/utilities/coerceInputValue.js +47 -0
  195. package/utilities/coerceInputValue.mjs +46 -0
  196. package/utilities/concatAST.d.ts +12 -0
  197. package/utilities/concatAST.js +13 -0
  198. package/utilities/concatAST.mjs +12 -0
  199. package/utilities/extendSchema.d.ts +56 -3
  200. package/utilities/extendSchema.js +63 -3
  201. package/utilities/extendSchema.mjs +62 -3
  202. package/utilities/findBreakingChanges.d.ts +95 -0
  203. package/utilities/findBreakingChanges.js +68 -0
  204. package/utilities/findBreakingChanges.mjs +70 -0
  205. package/utilities/getIntrospectionQuery.d.ts +132 -0
  206. package/utilities/getIntrospectionQuery.js +41 -0
  207. package/utilities/getIntrospectionQuery.mjs +41 -0
  208. package/utilities/getOperationAST.d.ts +15 -0
  209. package/utilities/getOperationAST.js +16 -0
  210. package/utilities/getOperationAST.mjs +15 -0
  211. package/utilities/getOperationRootType.d.ts +18 -1
  212. package/utilities/getOperationRootType.js +19 -1
  213. package/utilities/getOperationRootType.mjs +18 -1
  214. package/utilities/index.d.ts +7 -0
  215. package/utilities/index.mjs +7 -0
  216. package/utilities/introspectionFromSchema.d.ts +54 -0
  217. package/utilities/introspectionFromSchema.js +55 -0
  218. package/utilities/introspectionFromSchema.mjs +54 -0
  219. package/utilities/lexicographicSortSchema.d.ts +35 -0
  220. package/utilities/lexicographicSortSchema.js +36 -0
  221. package/utilities/lexicographicSortSchema.mjs +35 -0
  222. package/utilities/printSchema.d.ts +63 -0
  223. package/utilities/printSchema.js +66 -0
  224. package/utilities/printSchema.mjs +67 -0
  225. package/utilities/resolveSchemaCoordinate.d.ts +62 -0
  226. package/utilities/resolveSchemaCoordinate.js +64 -0
  227. package/utilities/resolveSchemaCoordinate.mjs +63 -0
  228. package/utilities/separateOperations.d.ts +30 -0
  229. package/utilities/separateOperations.js +31 -0
  230. package/utilities/separateOperations.mjs +30 -0
  231. package/utilities/stripIgnoredCharacters.d.ts +13 -6
  232. package/utilities/stripIgnoredCharacters.js +16 -6
  233. package/utilities/stripIgnoredCharacters.mjs +15 -6
  234. package/utilities/typeComparators.d.ts +84 -0
  235. package/utilities/typeComparators.js +85 -0
  236. package/utilities/typeComparators.mjs +84 -0
  237. package/utilities/typeFromAST.d.ts +86 -0
  238. package/utilities/typeFromAST.js +3 -0
  239. package/utilities/typeFromAST.mjs +3 -0
  240. package/utilities/typedQueryDocumentNode.d.ts +4 -0
  241. package/utilities/valueFromAST.d.ts +38 -0
  242. package/utilities/valueFromAST.js +39 -0
  243. package/utilities/valueFromAST.mjs +38 -0
  244. package/utilities/valueFromASTUntyped.d.ts +15 -2
  245. package/utilities/valueFromASTUntyped.js +16 -2
  246. package/utilities/valueFromASTUntyped.mjs +15 -2
  247. package/validation/ValidationContext.d.ts +399 -0
  248. package/validation/ValidationContext.js +400 -0
  249. package/validation/ValidationContext.mjs +401 -0
  250. package/validation/index.d.ts +6 -0
  251. package/validation/index.mjs +6 -0
  252. package/validation/rules/ExecutableDefinitionsRule.d.ts +28 -0
  253. package/validation/rules/ExecutableDefinitionsRule.js +29 -0
  254. package/validation/rules/ExecutableDefinitionsRule.mjs +28 -0
  255. package/validation/rules/FieldsOnCorrectTypeRule.d.ts +28 -0
  256. package/validation/rules/FieldsOnCorrectTypeRule.js +33 -0
  257. package/validation/rules/FieldsOnCorrectTypeRule.mjs +32 -0
  258. package/validation/rules/FragmentsOnCompositeTypesRule.d.ts +28 -0
  259. package/validation/rules/FragmentsOnCompositeTypesRule.js +29 -0
  260. package/validation/rules/FragmentsOnCompositeTypesRule.mjs +28 -0
  261. package/validation/rules/KnownArgumentNamesRule.d.ts +29 -3
  262. package/validation/rules/KnownArgumentNamesRule.js +30 -3
  263. package/validation/rules/KnownArgumentNamesRule.mjs +29 -3
  264. package/validation/rules/KnownDirectivesRule.d.ts +28 -0
  265. package/validation/rules/KnownDirectivesRule.js +29 -0
  266. package/validation/rules/KnownDirectivesRule.mjs +28 -0
  267. package/validation/rules/KnownFragmentNamesRule.d.ts +28 -0
  268. package/validation/rules/KnownFragmentNamesRule.js +29 -0
  269. package/validation/rules/KnownFragmentNamesRule.mjs +28 -0
  270. package/validation/rules/KnownTypeNamesRule.d.ts +28 -0
  271. package/validation/rules/KnownTypeNamesRule.js +29 -0
  272. package/validation/rules/KnownTypeNamesRule.mjs +28 -0
  273. package/validation/rules/LoneAnonymousOperationRule.d.ts +28 -0
  274. package/validation/rules/LoneAnonymousOperationRule.js +29 -0
  275. package/validation/rules/LoneAnonymousOperationRule.mjs +28 -0
  276. package/validation/rules/LoneSchemaDefinitionRule.d.ts +21 -0
  277. package/validation/rules/LoneSchemaDefinitionRule.js +22 -0
  278. package/validation/rules/LoneSchemaDefinitionRule.mjs +21 -0
  279. package/validation/rules/MaxIntrospectionDepthRule.d.ts +31 -0
  280. package/validation/rules/MaxIntrospectionDepthRule.js +33 -0
  281. package/validation/rules/MaxIntrospectionDepthRule.mjs +34 -0
  282. package/validation/rules/NoFragmentCyclesRule.d.ts +28 -0
  283. package/validation/rules/NoFragmentCyclesRule.js +29 -0
  284. package/validation/rules/NoFragmentCyclesRule.mjs +28 -0
  285. package/validation/rules/NoUndefinedVariablesRule.d.ts +28 -0
  286. package/validation/rules/NoUndefinedVariablesRule.js +29 -0
  287. package/validation/rules/NoUndefinedVariablesRule.mjs +28 -0
  288. package/validation/rules/NoUnusedFragmentsRule.d.ts +28 -0
  289. package/validation/rules/NoUnusedFragmentsRule.js +29 -0
  290. package/validation/rules/NoUnusedFragmentsRule.mjs +28 -0
  291. package/validation/rules/NoUnusedVariablesRule.d.ts +29 -0
  292. package/validation/rules/NoUnusedVariablesRule.js +30 -0
  293. package/validation/rules/NoUnusedVariablesRule.mjs +29 -0
  294. package/validation/rules/OverlappingFieldsCanBeMergedRule.d.ts +33 -0
  295. package/validation/rules/OverlappingFieldsCanBeMergedRule.js +45 -6
  296. package/validation/rules/OverlappingFieldsCanBeMergedRule.mjs +45 -6
  297. package/validation/rules/PossibleFragmentSpreadsRule.d.ts +36 -0
  298. package/validation/rules/PossibleFragmentSpreadsRule.js +37 -0
  299. package/validation/rules/PossibleFragmentSpreadsRule.mjs +36 -0
  300. package/validation/rules/PossibleTypeExtensionsRule.d.ts +21 -0
  301. package/validation/rules/PossibleTypeExtensionsRule.js +22 -0
  302. package/validation/rules/PossibleTypeExtensionsRule.mjs +21 -0
  303. package/validation/rules/ProvidedRequiredArgumentsRule.d.ts +29 -3
  304. package/validation/rules/ProvidedRequiredArgumentsRule.js +30 -3
  305. package/validation/rules/ProvidedRequiredArgumentsRule.mjs +29 -3
  306. package/validation/rules/ScalarLeafsRule.d.ts +28 -0
  307. package/validation/rules/ScalarLeafsRule.js +29 -0
  308. package/validation/rules/ScalarLeafsRule.mjs +28 -0
  309. package/validation/rules/SingleFieldSubscriptionsRule.d.ts +33 -0
  310. package/validation/rules/SingleFieldSubscriptionsRule.js +34 -0
  311. package/validation/rules/SingleFieldSubscriptionsRule.mjs +33 -0
  312. package/validation/rules/UniqueArgumentDefinitionNamesRule.d.ts +21 -0
  313. package/validation/rules/UniqueArgumentDefinitionNamesRule.js +22 -0
  314. package/validation/rules/UniqueArgumentDefinitionNamesRule.mjs +21 -0
  315. package/validation/rules/UniqueArgumentNamesRule.d.ts +28 -0
  316. package/validation/rules/UniqueArgumentNamesRule.js +29 -0
  317. package/validation/rules/UniqueArgumentNamesRule.mjs +28 -0
  318. package/validation/rules/UniqueDirectiveNamesRule.d.ts +21 -0
  319. package/validation/rules/UniqueDirectiveNamesRule.js +22 -0
  320. package/validation/rules/UniqueDirectiveNamesRule.mjs +21 -0
  321. package/validation/rules/UniqueDirectivesPerLocationRule.d.ts +28 -0
  322. package/validation/rules/UniqueDirectivesPerLocationRule.js +29 -0
  323. package/validation/rules/UniqueDirectivesPerLocationRule.mjs +28 -0
  324. package/validation/rules/UniqueEnumValueNamesRule.d.ts +21 -0
  325. package/validation/rules/UniqueEnumValueNamesRule.js +22 -0
  326. package/validation/rules/UniqueEnumValueNamesRule.mjs +21 -0
  327. package/validation/rules/UniqueFieldDefinitionNamesRule.d.ts +21 -0
  328. package/validation/rules/UniqueFieldDefinitionNamesRule.js +22 -0
  329. package/validation/rules/UniqueFieldDefinitionNamesRule.mjs +21 -0
  330. package/validation/rules/UniqueFragmentNamesRule.d.ts +28 -0
  331. package/validation/rules/UniqueFragmentNamesRule.js +29 -0
  332. package/validation/rules/UniqueFragmentNamesRule.mjs +28 -0
  333. package/validation/rules/UniqueInputFieldNamesRule.d.ts +32 -0
  334. package/validation/rules/UniqueInputFieldNamesRule.js +33 -0
  335. package/validation/rules/UniqueInputFieldNamesRule.mjs +32 -0
  336. package/validation/rules/UniqueOperationNamesRule.d.ts +28 -0
  337. package/validation/rules/UniqueOperationNamesRule.js +29 -0
  338. package/validation/rules/UniqueOperationNamesRule.mjs +28 -0
  339. package/validation/rules/UniqueOperationTypesRule.d.ts +21 -0
  340. package/validation/rules/UniqueOperationTypesRule.js +22 -0
  341. package/validation/rules/UniqueOperationTypesRule.mjs +21 -0
  342. package/validation/rules/UniqueTypeNamesRule.d.ts +21 -0
  343. package/validation/rules/UniqueTypeNamesRule.js +22 -0
  344. package/validation/rules/UniqueTypeNamesRule.mjs +21 -0
  345. package/validation/rules/UniqueVariableNamesRule.d.ts +28 -0
  346. package/validation/rules/UniqueVariableNamesRule.js +29 -0
  347. package/validation/rules/UniqueVariableNamesRule.mjs +28 -0
  348. package/validation/rules/ValuesOfCorrectTypeRule.d.ts +28 -0
  349. package/validation/rules/ValuesOfCorrectTypeRule.js +31 -0
  350. package/validation/rules/ValuesOfCorrectTypeRule.mjs +30 -0
  351. package/validation/rules/VariablesAreInputTypesRule.d.ts +32 -0
  352. package/validation/rules/VariablesAreInputTypesRule.js +33 -0
  353. package/validation/rules/VariablesAreInputTypesRule.mjs +32 -0
  354. package/validation/rules/VariablesInAllowedPositionRule.d.ts +28 -0
  355. package/validation/rules/VariablesInAllowedPositionRule.js +35 -1
  356. package/validation/rules/VariablesInAllowedPositionRule.mjs +34 -1
  357. package/validation/rules/custom/NoDeprecatedCustomRule.d.ts +41 -0
  358. package/validation/rules/custom/NoDeprecatedCustomRule.js +42 -0
  359. package/validation/rules/custom/NoDeprecatedCustomRule.mjs +41 -0
  360. package/validation/rules/custom/NoSchemaIntrospectionCustomRule.d.ts +28 -0
  361. package/validation/rules/custom/NoSchemaIntrospectionCustomRule.js +29 -0
  362. package/validation/rules/custom/NoSchemaIntrospectionCustomRule.mjs +28 -0
  363. package/validation/specifiedRules.d.ts +2 -3
  364. package/validation/specifiedRules.js +2 -3
  365. package/validation/specifiedRules.mjs +2 -3
  366. package/validation/validate.d.ts +70 -9
  367. package/validation/validate.js +63 -7
  368. package/validation/validate.mjs +63 -7
  369. package/version.d.ts +3 -6
  370. package/version.js +6 -8
  371. package/version.mjs +5 -8
@@ -7,6 +7,8 @@ exports.identityFunc = identityFunc;
7
7
 
8
8
  /**
9
9
  * Returns the first argument it receives.
10
+ *
11
+ * @internal
10
12
  */
11
13
  function identityFunc(x) {
12
14
  return x;
@@ -1,5 +1,7 @@
1
1
  /**
2
2
  * Returns the first argument it receives.
3
+ *
4
+ * @internal
3
5
  */
4
6
  export function identityFunc(x) {
5
7
  return x;
@@ -1,4 +1,6 @@
1
1
  /**
2
2
  * Used to print values in error messages.
3
+ *
4
+ * @internal
3
5
  */
4
6
  export declare function inspect(value: unknown): string;
@@ -8,6 +8,8 @@ const MAX_ARRAY_LENGTH = 10;
8
8
  const MAX_RECURSIVE_DEPTH = 2;
9
9
  /**
10
10
  * Used to print values in error messages.
11
+ *
12
+ * @internal
11
13
  */
12
14
 
13
15
  function inspect(value) {
@@ -2,6 +2,8 @@ const MAX_ARRAY_LENGTH = 10;
2
2
  const MAX_RECURSIVE_DEPTH = 2;
3
3
  /**
4
4
  * Used to print values in error messages.
5
+ *
6
+ * @internal
5
7
  */
6
8
 
7
9
  export function inspect(value) {
@@ -3,6 +3,8 @@
3
3
  * constructors are detected.
4
4
  * See: https://expressjs.com/en/advanced/best-practice-performance.html#set-node_env-to-production
5
5
  * See: https://webpack.js.org/guides/production/
6
+ *
7
+ * @internal
6
8
  */
7
9
  export declare const instanceOf: (
8
10
  value: unknown,
@@ -16,6 +16,8 @@ const isProduction =
16
16
  * constructors are detected.
17
17
  * See: https://expressjs.com/en/advanced/best-practice-performance.html#set-node_env-to-production
18
18
  * See: https://webpack.js.org/guides/production/
19
+ *
20
+ * @internal
19
21
  */
20
22
 
21
23
  const instanceOf =
@@ -9,6 +9,8 @@ const isProduction =
9
9
  * constructors are detected.
10
10
  * See: https://expressjs.com/en/advanced/best-practice-performance.html#set-node_env-to-production
11
11
  * See: https://webpack.js.org/guides/production/
12
+ *
13
+ * @internal
12
14
  */
13
15
 
14
16
  export const instanceOf =
@@ -1,3 +1,4 @@
1
+ /** @internal */
1
2
  export declare function invariant(
2
3
  condition: unknown,
3
4
  message?: string,
@@ -5,6 +5,7 @@ Object.defineProperty(exports, '__esModule', {
5
5
  });
6
6
  exports.invariant = invariant;
7
7
 
8
+ /** @internal */
8
9
  function invariant(condition, message) {
9
10
  const booleanCondition = Boolean(condition);
10
11
 
@@ -1,3 +1,4 @@
1
+ /** @internal */
1
2
  export function invariant(condition, message) {
2
3
  const booleanCondition = Boolean(condition);
3
4
 
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Returns true if the provided object implements the AsyncIterator protocol via
3
3
  * implementing a `Symbol.asyncIterator` method.
4
+ *
5
+ * @internal
4
6
  */
5
7
  export declare function isAsyncIterable(
6
8
  maybeAsyncIterable: any,
@@ -8,6 +8,8 @@ exports.isAsyncIterable = isAsyncIterable;
8
8
  /**
9
9
  * Returns true if the provided object implements the AsyncIterator protocol via
10
10
  * implementing a `Symbol.asyncIterator` method.
11
+ *
12
+ * @internal
11
13
  */
12
14
  function isAsyncIterable(maybeAsyncIterable) {
13
15
  return (
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Returns true if the provided object implements the AsyncIterator protocol via
3
3
  * implementing a `Symbol.asyncIterator` method.
4
+ *
5
+ * @internal
4
6
  */
5
7
  export function isAsyncIterable(maybeAsyncIterable) {
6
8
  return (
@@ -6,13 +6,14 @@
6
6
  * an object should be iterated-over e.g. Array, Map, Set, Int8Array,
7
7
  * TypedArray, etc. but excludes string literals.
8
8
  *
9
+ * @internal
9
10
  * @example
10
11
  * ```ts
11
- * isIterableObject([ 1, 2, 3 ]) // true
12
- * isIterableObject(new Map()) // true
13
- * isIterableObject('ABC') // false
14
- * isIterableObject({ key: 'value' }) // false
15
- * isIterableObject({ length: 1, 0: 'Alpha' }) // false
12
+ * isIterableObject([1, 2, 3]); // => true
13
+ * isIterableObject(new Map()); // => true
14
+ * isIterableObject('ABC'); // => false
15
+ * isIterableObject({ key: 'value' }); // => false
16
+ * isIterableObject({ length: 1, 0: 'Alpha' }); // => false
16
17
  * ```
17
18
  */
18
19
  export declare function isIterableObject(
@@ -13,13 +13,14 @@ exports.isIterableObject = isIterableObject;
13
13
  * an object should be iterated-over e.g. Array, Map, Set, Int8Array,
14
14
  * TypedArray, etc. but excludes string literals.
15
15
  *
16
+ * @internal
16
17
  * @example
17
18
  * ```ts
18
- * isIterableObject([ 1, 2, 3 ]) // true
19
- * isIterableObject(new Map()) // true
20
- * isIterableObject('ABC') // false
21
- * isIterableObject({ key: 'value' }) // false
22
- * isIterableObject({ length: 1, 0: 'Alpha' }) // false
19
+ * isIterableObject([1, 2, 3]); // => true
20
+ * isIterableObject(new Map()); // => true
21
+ * isIterableObject('ABC'); // => false
22
+ * isIterableObject({ key: 'value' }); // => false
23
+ * isIterableObject({ length: 1, 0: 'Alpha' }); // => false
23
24
  * ```
24
25
  */
25
26
  function isIterableObject(maybeIterable) {
@@ -6,13 +6,14 @@
6
6
  * an object should be iterated-over e.g. Array, Map, Set, Int8Array,
7
7
  * TypedArray, etc. but excludes string literals.
8
8
  *
9
+ * @internal
9
10
  * @example
10
11
  * ```ts
11
- * isIterableObject([ 1, 2, 3 ]) // true
12
- * isIterableObject(new Map()) // true
13
- * isIterableObject('ABC') // false
14
- * isIterableObject({ key: 'value' }) // false
15
- * isIterableObject({ length: 1, 0: 'Alpha' }) // false
12
+ * isIterableObject([1, 2, 3]); // => true
13
+ * isIterableObject(new Map()); // => true
14
+ * isIterableObject('ABC'); // => false
15
+ * isIterableObject({ key: 'value' }); // => false
16
+ * isIterableObject({ length: 1, 0: 'Alpha' }); // => false
16
17
  * ```
17
18
  */
18
19
  export function isIterableObject(maybeIterable) {
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Return true if `value` is object-like. A value is object-like if it's not
3
3
  * `null` and has a `typeof` result of "object".
4
+ *
5
+ * @internal
4
6
  */
5
7
  export declare function isObjectLike(value: unknown): value is {
6
8
  [key: string]: unknown;
@@ -8,6 +8,8 @@ exports.isObjectLike = isObjectLike;
8
8
  /**
9
9
  * Return true if `value` is object-like. A value is object-like if it's not
10
10
  * `null` and has a `typeof` result of "object".
11
+ *
12
+ * @internal
11
13
  */
12
14
  function isObjectLike(value) {
13
15
  return typeof value == 'object' && value !== null;
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Return true if `value` is object-like. A value is object-like if it's not
3
3
  * `null` and has a `typeof` result of "object".
4
+ *
5
+ * @internal
4
6
  */
5
7
  export function isObjectLike(value) {
6
8
  return typeof value == 'object' && value !== null;
@@ -1,5 +1,7 @@
1
1
  /**
2
2
  * Returns true if the value acts like a Promise, i.e. has a "then" function,
3
3
  * otherwise returns false.
4
+ *
5
+ * @internal
4
6
  */
5
7
  export declare function isPromise(value: any): value is Promise<unknown>;
@@ -8,6 +8,8 @@ exports.isPromise = isPromise;
8
8
  /**
9
9
  * Returns true if the value acts like a Promise, i.e. has a "then" function,
10
10
  * otherwise returns false.
11
+ *
12
+ * @internal
11
13
  */
12
14
  function isPromise(value) {
13
15
  return (
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Returns true if the value acts like a Promise, i.e. has a "then" function,
3
3
  * otherwise returns false.
4
+ *
5
+ * @internal
4
6
  */
5
7
  export function isPromise(value) {
6
8
  return (
@@ -5,25 +5,18 @@ import type { ObjMap } from './ObjMap';
5
5
  *
6
6
  * This provides a convenient lookup for the array items if the key function
7
7
  * produces unique results.
8
+ * @internal
9
+ * @example
8
10
  * ```ts
9
11
  * const phoneBook = [
10
12
  * { name: 'Jon', num: '555-1234' },
11
- * { name: 'Jenny', num: '867-5309' }
12
- * ]
13
+ * { name: 'Jenny', num: '867-5309' },
14
+ * ];
13
15
  *
14
- * const entriesByName = keyMap(
15
- * phoneBook,
16
- * entry => entry.name
17
- * )
16
+ * const entriesByName = keyMap(phoneBook, (entry) => entry.name);
18
17
  *
19
- * // {
20
- * // Jon: { name: 'Jon', num: '555-1234' },
21
- * // Jenny: { name: 'Jenny', num: '867-5309' }
22
- * // }
23
- *
24
- * const jennyEntry = entriesByName['Jenny']
25
- *
26
- * // { name: 'Jenny', num: '857-6309' }
18
+ * Object.keys(entriesByName); // => ['Jon', 'Jenny']
19
+ * entriesByName['Jenny']; // => { name: 'Jenny', num: '867-5309' }
27
20
  * ```
28
21
  */
29
22
  export declare function keyMap<T>(
package/jsutils/keyMap.js CHANGED
@@ -11,25 +11,18 @@ exports.keyMap = keyMap;
11
11
  *
12
12
  * This provides a convenient lookup for the array items if the key function
13
13
  * produces unique results.
14
+ * @internal
15
+ * @example
14
16
  * ```ts
15
17
  * const phoneBook = [
16
18
  * { name: 'Jon', num: '555-1234' },
17
- * { name: 'Jenny', num: '867-5309' }
18
- * ]
19
+ * { name: 'Jenny', num: '867-5309' },
20
+ * ];
19
21
  *
20
- * const entriesByName = keyMap(
21
- * phoneBook,
22
- * entry => entry.name
23
- * )
22
+ * const entriesByName = keyMap(phoneBook, (entry) => entry.name);
24
23
  *
25
- * // {
26
- * // Jon: { name: 'Jon', num: '555-1234' },
27
- * // Jenny: { name: 'Jenny', num: '867-5309' }
28
- * // }
29
- *
30
- * const jennyEntry = entriesByName['Jenny']
31
- *
32
- * // { name: 'Jenny', num: '857-6309' }
24
+ * Object.keys(entriesByName); // => ['Jon', 'Jenny']
25
+ * entriesByName['Jenny']; // => { name: 'Jenny', num: '867-5309' }
33
26
  * ```
34
27
  */
35
28
  function keyMap(list, keyFn) {
@@ -4,25 +4,18 @@
4
4
  *
5
5
  * This provides a convenient lookup for the array items if the key function
6
6
  * produces unique results.
7
+ * @internal
8
+ * @example
7
9
  * ```ts
8
10
  * const phoneBook = [
9
11
  * { name: 'Jon', num: '555-1234' },
10
- * { name: 'Jenny', num: '867-5309' }
11
- * ]
12
+ * { name: 'Jenny', num: '867-5309' },
13
+ * ];
12
14
  *
13
- * const entriesByName = keyMap(
14
- * phoneBook,
15
- * entry => entry.name
16
- * )
15
+ * const entriesByName = keyMap(phoneBook, (entry) => entry.name);
17
16
  *
18
- * // {
19
- * // Jon: { name: 'Jon', num: '555-1234' },
20
- * // Jenny: { name: 'Jenny', num: '867-5309' }
21
- * // }
22
- *
23
- * const jennyEntry = entriesByName['Jenny']
24
- *
25
- * // { name: 'Jenny', num: '857-6309' }
17
+ * Object.keys(entriesByName); // => ['Jon', 'Jenny']
18
+ * entriesByName['Jenny']; // => { name: 'Jenny', num: '867-5309' }
26
19
  * ```
27
20
  */
28
21
  export function keyMap(list, keyFn) {
@@ -2,18 +2,21 @@ import type { ObjMap } from './ObjMap';
2
2
  /**
3
3
  * Creates a keyed JS object from an array, given a function to produce the keys
4
4
  * and a function to produce the values from each item in the array.
5
+ * @internal
6
+ * @example
5
7
  * ```ts
6
8
  * const phoneBook = [
7
9
  * { name: 'Jon', num: '555-1234' },
8
- * { name: 'Jenny', num: '867-5309' }
9
- * ]
10
+ * { name: 'Jenny', num: '867-5309' },
11
+ * ];
10
12
  *
11
- * // { Jon: '555-1234', Jenny: '867-5309' }
12
13
  * const phonesByName = keyValMap(
13
14
  * phoneBook,
14
- * entry => entry.name,
15
- * entry => entry.num
16
- * )
15
+ * (entry) => entry.name,
16
+ * (entry) => entry.num,
17
+ * );
18
+ *
19
+ * phonesByName; // => { Jon: '555-1234', Jenny: '867-5309' }
17
20
  * ```
18
21
  */
19
22
  export declare function keyValMap<T, V>(
@@ -8,18 +8,21 @@ exports.keyValMap = keyValMap;
8
8
  /**
9
9
  * Creates a keyed JS object from an array, given a function to produce the keys
10
10
  * and a function to produce the values from each item in the array.
11
+ * @internal
12
+ * @example
11
13
  * ```ts
12
14
  * const phoneBook = [
13
15
  * { name: 'Jon', num: '555-1234' },
14
- * { name: 'Jenny', num: '867-5309' }
15
- * ]
16
+ * { name: 'Jenny', num: '867-5309' },
17
+ * ];
16
18
  *
17
- * // { Jon: '555-1234', Jenny: '867-5309' }
18
19
  * const phonesByName = keyValMap(
19
20
  * phoneBook,
20
- * entry => entry.name,
21
- * entry => entry.num
22
- * )
21
+ * (entry) => entry.name,
22
+ * (entry) => entry.num,
23
+ * );
24
+ *
25
+ * phonesByName; // => { Jon: '555-1234', Jenny: '867-5309' }
23
26
  * ```
24
27
  */
25
28
  function keyValMap(list, keyFn, valFn) {
@@ -1,18 +1,21 @@
1
1
  /**
2
2
  * Creates a keyed JS object from an array, given a function to produce the keys
3
3
  * and a function to produce the values from each item in the array.
4
+ * @internal
5
+ * @example
4
6
  * ```ts
5
7
  * const phoneBook = [
6
8
  * { name: 'Jon', num: '555-1234' },
7
- * { name: 'Jenny', num: '867-5309' }
8
- * ]
9
+ * { name: 'Jenny', num: '867-5309' },
10
+ * ];
9
11
  *
10
- * // { Jon: '555-1234', Jenny: '867-5309' }
11
12
  * const phonesByName = keyValMap(
12
13
  * phoneBook,
13
- * entry => entry.name,
14
- * entry => entry.num
15
- * )
14
+ * (entry) => entry.name,
15
+ * (entry) => entry.num,
16
+ * );
17
+ *
18
+ * phonesByName; // => { Jon: '555-1234', Jenny: '867-5309' }
16
19
  * ```
17
20
  */
18
21
  export function keyValMap(list, keyFn, valFn) {
@@ -2,6 +2,8 @@ import type { ObjMap, ReadOnlyObjMap } from './ObjMap';
2
2
  /**
3
3
  * Creates an object map with the same keys as `map` and values generated by
4
4
  * running each value of `map` thru `fn`.
5
+ *
6
+ * @internal
5
7
  */
6
8
  export declare function mapValue<T, V>(
7
9
  map: ReadOnlyObjMap<T>,
@@ -8,6 +8,8 @@ exports.mapValue = mapValue;
8
8
  /**
9
9
  * Creates an object map with the same keys as `map` and values generated by
10
10
  * running each value of `map` thru `fn`.
11
+ *
12
+ * @internal
11
13
  */
12
14
  function mapValue(map, fn) {
13
15
  const result = Object.create(null);
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Creates an object map with the same keys as `map` and values generated by
3
3
  * running each value of `map` thru `fn`.
4
+ *
5
+ * @internal
4
6
  */
5
7
  export function mapValue(map, fn) {
6
8
  const result = Object.create(null);
@@ -1,5 +1,7 @@
1
1
  /**
2
2
  * Memoizes the provided three-argument function.
3
+ *
4
+ * @internal
3
5
  */
4
6
  export declare function memoize3<
5
7
  A1 extends object,
@@ -7,6 +7,8 @@ exports.memoize3 = memoize3;
7
7
 
8
8
  /**
9
9
  * Memoizes the provided three-argument function.
10
+ *
11
+ * @internal
10
12
  */
11
13
  function memoize3(fn) {
12
14
  let cache0;
@@ -1,5 +1,7 @@
1
1
  /**
2
2
  * Memoizes the provided three-argument function.
3
+ *
4
+ * @internal
3
5
  */
4
6
  export function memoize3(fn) {
5
7
  let cache0;
@@ -4,5 +4,7 @@
4
4
  *
5
5
  * See: https://en.wikipedia.org/wiki/Natural_sort_order
6
6
  *
7
+ *
8
+ * @internal
7
9
  */
8
10
  export declare function naturalCompare(aStr: string, bStr: string): number;
@@ -11,6 +11,8 @@ exports.naturalCompare = naturalCompare;
11
11
  *
12
12
  * See: https://en.wikipedia.org/wiki/Natural_sort_order
13
13
  *
14
+ *
15
+ * @internal
14
16
  */
15
17
  function naturalCompare(aStr, bStr) {
16
18
  let aIndex = 0;
@@ -4,6 +4,8 @@
4
4
  *
5
5
  * See: https://en.wikipedia.org/wiki/Natural_sort_order
6
6
  *
7
+ *
8
+ * @internal
7
9
  */
8
10
  export function naturalCompare(aStr, bStr) {
9
11
  let aIndex = 0;
@@ -1,5 +1,7 @@
1
1
  /**
2
2
  * Build a string describing the path.
3
+ *
4
+ * @internal
3
5
  */
4
6
  export declare function printPathArray(
5
7
  path: ReadonlyArray<string | number>,
@@ -7,6 +7,8 @@ exports.printPathArray = printPathArray;
7
7
 
8
8
  /**
9
9
  * Build a string describing the path.
10
+ *
11
+ * @internal
10
12
  */
11
13
  function printPathArray(path) {
12
14
  return path
@@ -1,5 +1,7 @@
1
1
  /**
2
2
  * Build a string describing the path.
3
+ *
4
+ * @internal
3
5
  */
4
6
  export function printPathArray(path) {
5
7
  return path
@@ -5,6 +5,8 @@ import type { ObjMap } from './ObjMap';
5
5
  *
6
6
  * This is akin to bluebird's `Promise.props`, but implemented only using
7
7
  * `Promise.all` so it will work with any implementation of ES6 promises.
8
+ *
9
+ * @internal
8
10
  */
9
11
  export declare function promiseForObject<T>(
10
12
  object: ObjMap<Promise<T>>,
@@ -11,6 +11,8 @@ exports.promiseForObject = promiseForObject;
11
11
  *
12
12
  * This is akin to bluebird's `Promise.props`, but implemented only using
13
13
  * `Promise.all` so it will work with any implementation of ES6 promises.
14
+ *
15
+ * @internal
14
16
  */
15
17
  function promiseForObject(object) {
16
18
  return Promise.all(Object.values(object)).then((resolvedValues) => {
@@ -4,6 +4,8 @@
4
4
  *
5
5
  * This is akin to bluebird's `Promise.props`, but implemented only using
6
6
  * `Promise.all` so it will work with any implementation of ES6 promises.
7
+ *
8
+ * @internal
7
9
  */
8
10
  export function promiseForObject(object) {
9
11
  return Promise.all(Object.values(object)).then((resolvedValues) => {
@@ -5,6 +5,8 @@ import type { PromiseOrValue } from './PromiseOrValue';
5
5
  *
6
6
  * If the callback does not return a Promise, then this function will also not
7
7
  * return a Promise.
8
+ *
9
+ * @internal
8
10
  */
9
11
  export declare function promiseReduce<T, U>(
10
12
  values: Iterable<T>,
@@ -13,6 +13,8 @@ var _isPromise = require('./isPromise.js');
13
13
  *
14
14
  * If the callback does not return a Promise, then this function will also not
15
15
  * return a Promise.
16
+ *
17
+ * @internal
16
18
  */
17
19
  function promiseReduce(values, callbackFn, initialValue) {
18
20
  let accumulator = initialValue;
@@ -6,6 +6,8 @@ import { isPromise } from './isPromise.mjs';
6
6
  *
7
7
  * If the callback does not return a Promise, then this function will also not
8
8
  * return a Promise.
9
+ *
10
+ * @internal
9
11
  */
10
12
  export function promiseReduce(values, callbackFn, initialValue) {
11
13
  let accumulator = initialValue;
@@ -1,6 +1,8 @@
1
1
  /**
2
2
  * Given an invalid input string and a list of valid options, returns a filtered
3
3
  * list of valid options sorted based on their similarity with the input.
4
+ *
5
+ * @internal
4
6
  */
5
7
  export declare function suggestionList(
6
8
  input: string,
@@ -10,6 +10,8 @@ var _naturalCompare = require('./naturalCompare.js');
10
10
  /**
11
11
  * Given an invalid input string and a list of valid options, returns a filtered
12
12
  * list of valid options sorted based on their similarity with the input.
13
+ *
14
+ * @internal
13
15
  */
14
16
  function suggestionList(input, options) {
15
17
  const optionsByDistance = Object.create(null);
@@ -44,6 +46,8 @@ function suggestionList(input, options) {
44
46
  * of 1.
45
47
  *
46
48
  * This distance can be useful for detecting typos in input or sorting
49
+ *
50
+ * @internal
47
51
  */
48
52
 
49
53
  class LexicalDistance {