Skip to content

Commit

Permalink
*.d.ts: Swith comments to comment to TSDoc
Browse files Browse the repository at this point in the history 
Typescript strips all non-TSDoc documents in generated definitions
  • Loading branch information
@IvanGoncharov
IvanGoncharov committed May 21, 2021
1 parent 1bd65a3 commit e3e90fc
Show file tree
Hide file tree
Showing 25 changed files with 378 additions and 357 deletions.
122 changes: 60 additions & 62 deletions src/index.d.ts
View file
Expand Up @@ -22,13 +22,13 @@
* import { parse } from 'graphql';
* import { parse } from 'graphql/language';
*/
// The GraphQL.js version info.
/** The GraphQL.js version info. */
export { version, versionInfo } from './version';
// The primary entry point into fulfilling a GraphQL request.
/** The primary entry point into fulfilling a GraphQL request. */
export { GraphQLArgs, graphql, graphqlSync } from './graphql';
// Create and operate on GraphQL type definitions and schema.
/** Create and operate on GraphQL type definitions and schema. */
export {
// Definitions
/** Definitions */
GraphQLSchema,
GraphQLDirective,
GraphQLScalarType,
Expand All @@ -39,24 +39,24 @@ export {
GraphQLInputObjectType,
GraphQLList,
GraphQLNonNull,
// Standard GraphQL Scalars
/** Standard GraphQL Scalars */
specifiedScalarTypes,
GraphQLInt,
GraphQLFloat,
GraphQLString,
GraphQLBoolean,
GraphQLID,
// Built-in Directives defined by the Spec
/** Built-in Directives defined by the Spec */
specifiedDirectives,
GraphQLIncludeDirective,
GraphQLSkipDirective,
GraphQLDeprecatedDirective,
GraphQLSpecifiedByDirective,
// "Enum" of Type Kinds
/** "Enum" of Type Kinds */
TypeKind,
// Constant Deprecation Reason
/** Constant Deprecation Reason */
DEFAULT_DEPRECATION_REASON,
// GraphQL Types for introspection.
/** GraphQL Types for introspection. */
introspectionTypes,
__Schema,
__Directive,
Expand All @@ -66,11 +66,11 @@ export {
__InputValue,
__EnumValue,
__TypeKind,
// Meta-field definitions.
/** Meta-field definitions. */
SchemaMetaFieldDef,
TypeMetaFieldDef,
TypeNameMetaFieldDef,
// Predicates
/** Predicates */
isSchema,
isDirective,
isType,
Expand All @@ -95,7 +95,7 @@ export {
isSpecifiedScalarType,
isIntrospectionType,
isSpecifiedDirective,
// Assertions
/** Assertions */
assertSchema,
assertDirective,
assertType,
Expand All @@ -115,10 +115,10 @@ export {
assertWrappingType,
assertNullableType,
assertNamedType,
// Un-modifiers
/** Un-modifiers */
getNullableType,
getNamedType,
// Validate GraphQL schema.
/** Validate GraphQL schema. */
validateSchema,
assertValidSchema,
} from './type/index';
Expand Down Expand Up @@ -179,33 +179,33 @@ export {
GraphQLScalarValueParser,
GraphQLScalarLiteralParser,
} from './type/index';
// Parse and operate on GraphQL language source files.
/** Parse and operate on GraphQL language source files. */
export {
Token,
Source,
Location,
getLocation,
// Print source location
/** Print source location */
printLocation,
printSourceLocation,
// Lex
/** Lex */
Lexer,
TokenKind,
// Parse
/** Parse */
parse,
parseValue,
parseConstValue,
parseType,
// Print
/** Print */
print,
// Visit
/** Visit */
visit,
visitInParallel,
getVisitFn,
BREAK,
Kind,
DirectiveLocation,
// Predicates
/** Predicates */
isDefinitionNode,
isExecutableDefinitionNode,
isSelectionNode,
Expand All @@ -223,13 +223,13 @@ export {
TokenKindEnum,
KindEnum,
DirectiveLocationEnum,
// Visitor utilities
/** Visitor utilities */
ASTVisitor,
ASTVisitFn,
// AST nodes
/** AST nodes */
ASTNode,
ASTKindToNode,
// Each kind of AST node
/** Each kind of AST node */
NameNode,
DocumentNode,
DefinitionNode,
Expand Down Expand Up @@ -290,7 +290,7 @@ export {
EnumTypeExtensionNode,
InputObjectTypeExtensionNode,
} from './language/index';
// Execute GraphQL queries.
/** Execute GraphQL queries. */
export {
execute,
executeSync,
Expand All @@ -307,13 +307,13 @@ export {
createSourceEventStream,
SubscriptionArgs,
} from './subscription/index';
// Validate GraphQL documents.
/** Validate GraphQL documents. */
export {
validate,
ValidationContext,
// All validation rules in the GraphQL Specification.
/** All validation rules in the GraphQL Specification. */
specifiedRules,
// Individual validation rules.
/** Individual validation rules. */
ExecutableDefinitionsRule,
FieldsOnCorrectTypeRule,
FragmentsOnCompositeTypesRule,
Expand All @@ -340,20 +340,20 @@ export {
ValuesOfCorrectTypeRule,
VariablesAreInputTypesRule,
VariablesInAllowedPositionRule,
// SDL-specific validation rules
/** SDL-specific validation rules */
LoneSchemaDefinitionRule,
UniqueOperationTypesRule,
UniqueTypeNamesRule,
UniqueEnumValueNamesRule,
UniqueFieldDefinitionNamesRule,
UniqueDirectiveNamesRule,
PossibleTypeExtensionsRule,
// Custom validation rules
/** Custom validation rules */
NoDeprecatedCustomRule,
NoSchemaIntrospectionCustomRule,
ValidationRule,
} from './validation/index';
// Create, format, and print GraphQL errors.
/** Create, format, and print GraphQL errors. */
export {
GraphQLError,
syntaxError,
Expand All @@ -362,65 +362,63 @@ export {
formatError,
GraphQLFormattedError,
} from './error/index';
// Utilities for operating on GraphQL type schema and parsed sources.
/** Utilities for operating on GraphQL type schema and parsed sources. */
export {
// Produce the GraphQL query recommended for a full schema introspection.
// Accepts optional IntrospectionOptions.
/**
* Produce the GraphQL query recommended for a full schema introspection.
* Accepts optional IntrospectionOptions.
*/
getIntrospectionQuery,
// Gets the target Operation from a Document.
/** Gets the target Operation from a Document. */
getOperationAST,
// Gets the Type for the target Operation AST.
/** Gets the Type for the target Operation AST. */
getOperationRootType,
// Convert a GraphQLSchema to an IntrospectionQuery.
/** Convert a GraphQLSchema to an IntrospectionQuery. */
introspectionFromSchema,
// Build a GraphQLSchema from an introspection result.
/** Build a GraphQLSchema from an introspection result. */
buildClientSchema,
// Build a GraphQLSchema from a parsed GraphQL Schema language AST.
/** Build a GraphQLSchema from a parsed GraphQL Schema language AST. */
buildASTSchema,
// Build a GraphQLSchema from a GraphQL schema language document.
/** Build a GraphQLSchema from a GraphQL schema language document. */
buildSchema,
// Extends an existing GraphQLSchema from a parsed GraphQL Schema
// language AST.
/** Extends an existing GraphQLSchema from a parsed GraphQL Schema language AST. */
extendSchema,
// Sort a GraphQLSchema.
/** Sort a GraphQLSchema. */
lexicographicSortSchema,
// Print a GraphQLSchema to GraphQL Schema language.
/** Print a GraphQLSchema to GraphQL Schema language. */
printSchema,
// Print a GraphQLType to GraphQL Schema language.
/** Print a GraphQLType to GraphQL Schema language. */
printType,
// Prints the built-in introspection schema in the Schema Language
// format.
/** Prints the built-in introspection schema in the Schema Language format. */
printIntrospectionSchema,
// Create a GraphQLType from a GraphQL language AST.
/** Create a GraphQLType from a GraphQL language AST. */
typeFromAST,
// Create a JavaScript value from a GraphQL language AST with a Type.
/** Create a JavaScript value from a GraphQL language AST with a Type. */
valueFromAST,
// Create a JavaScript value from a GraphQL language AST without a Type.
/** Create a JavaScript value from a GraphQL language AST without a Type. */
valueFromASTUntyped,
// Create a GraphQL language AST from a JavaScript value.
/** Create a GraphQL language AST from a JavaScript value. */
astFromValue,
// A helper to use within recursive-descent visitors which need to be aware of
// the GraphQL type system.
/** A helper to use within recursive-descent visitors which need to be aware of the GraphQL type system. */
TypeInfo,
visitWithTypeInfo,
// Coerces a JavaScript value to a GraphQL type, or produces errors.
/** Coerces a JavaScript value to a GraphQL type, or produces errors. */
coerceInputValue,
// Concatenates multiple AST together.
/** Concatenates multiple AST together. */
concatAST,
// Separates an AST into an AST per Operation.
/** Separates an AST into an AST per Operation. */
separateOperations,
// Strips characters that are not significant to the validity or execution
// of a GraphQL document.
/** Strips characters that are not significant to the validity or execution of a GraphQL document. */
stripIgnoredCharacters,
// Comparators for types
/** Comparators for types */
isEqualType,
isTypeSubTypeOf,
doTypesOverlap,
// Asserts a string is a valid GraphQL name.
/** Asserts a string is a valid GraphQL name. */
assertValidName,
// Determine if a string is a valid GraphQL name.
/** Determine if a string is a valid GraphQL name. */
isValidNameError,
// Compares two GraphQLSchemas and detects breaking changes.
/** Compares two GraphQLSchemas and detects breaking changes. */
BreakingChangeType,
DangerousChangeType,
findBreakingChanges,
Expand Down

0 comments on commit e3e90fc

Please sign in to comment.