@vnodes/graphql
Preparing search index...
GraphQLAstExplorer
Class GraphQLAstExplorer
Index
Constructors
constructor
Methods
add
Symbol
If
Root
explore
get
Default
Types
get
Field
Type
Definition
get
Function
Parameters
get
Type
is
Root
to
Definition
Structures
to
Enum
Definition
Structure
to
Method
Declaration
Structure
to
Object
Type
Definition
Structure
to
Property
Declaration
Structure
to
Root
Schema
Definition
Structure
to
Scalar
Definition
Structure
to
Union
Definition
Structure
unwrap
Type
If
Non
Null
Constructors
constructor
new
GraphQLAstExplorer
()
:
GraphQLAstExplorer
Returns
GraphQLAstExplorer
Methods
add
Symbol
If
Root
addSymbolIfRoot
(
name
:
string
)
:
string
Parameters
name
:
string
Returns
string
explore
explore
(
documentNode
:
DocumentNode
,
outputPath
:
string
,
mode
:
"class"
|
"interface"
,
options
?:
DefinitionsGeneratorOptions
,
)
:
Promise
<
SourceFile
>
Parameters
documentNode
:
DocumentNode
outputPath
:
string
mode
:
"class"
|
"interface"
Optional
options
:
DefinitionsGeneratorOptions
Returns
Promise
<
SourceFile
>
get
Default
Types
getDefaultTypes
(
options
:
DefinitionsGeneratorOptions
,
)
:
{
[
type
:
string
]:
string
}
Parameters
options
:
DefinitionsGeneratorOptions
Returns
{
[
type
:
string
]:
string
}
get
Field
Type
Definition
getFieldTypeDefinition
(
typeNode
:
TypeNode
,
options
:
DefinitionsGeneratorOptions
,
)
:
{
name
:
string
;
required
:
boolean
}
Parameters
typeNode
:
TypeNode
options
:
DefinitionsGeneratorOptions
Returns
{
name
:
string
;
required
:
boolean
}
get
Function
Parameters
getFunctionParameters
(
inputs
:
readonly
InputValueDefinitionNode
[]
,
options
:
DefinitionsGeneratorOptions
,
)
:
ParameterDeclarationStructure
[]
Parameters
inputs
:
readonly
InputValueDefinitionNode
[]
options
:
DefinitionsGeneratorOptions
Returns
ParameterDeclarationStructure
[]
get
Type
getType
(
typeName
:
string
,
options
:
DefinitionsGeneratorOptions
)
:
string
Parameters
typeName
:
string
options
:
DefinitionsGeneratorOptions
Returns
string
is
Root
isRoot
(
name
:
string
)
:
boolean
Parameters
name
:
string
Returns
boolean
to
Definition
Structures
toDefinitionStructures
(
item
:
Readonly
<
TypeSystemDefinitionNode
|
TypeSystemExtensionNode
>
,
mode
:
"class"
|
"interface"
,
options
:
DefinitionsGeneratorOptions
,
)
:
any
Parameters
item
:
Readonly
<
TypeSystemDefinitionNode
|
TypeSystemExtensionNode
>
mode
:
"class"
|
"interface"
options
:
DefinitionsGeneratorOptions
Returns
any
to
Enum
Definition
Structure
toEnumDefinitionStructure
(
item
:
EnumTypeDefinitionNode
|
EnumTypeExtensionNode
,
options
:
DefinitionsGeneratorOptions
,
)
:
any
Parameters
item
:
EnumTypeDefinitionNode
|
EnumTypeExtensionNode
options
:
DefinitionsGeneratorOptions
Returns
any
to
Method
Declaration
Structure
toMethodDeclarationStructure
(
item
:
FieldDefinitionNode
|
InputValueDefinitionNode
,
mode
:
"class"
|
"interface"
,
options
:
DefinitionsGeneratorOptions
,
)
:
any
Parameters
item
:
FieldDefinitionNode
|
InputValueDefinitionNode
mode
:
"class"
|
"interface"
options
:
DefinitionsGeneratorOptions
Returns
any
to
Object
Type
Definition
Structure
toObjectTypeDefinitionStructure
(
item
:
|
ObjectTypeDefinitionNode
|
InterfaceTypeDefinitionNode
|
InputObjectTypeDefinitionNode
|
ObjectTypeExtensionNode
|
InterfaceTypeExtensionNode
|
InputObjectTypeExtensionNode
,
mode
:
"class"
|
"interface"
,
options
:
DefinitionsGeneratorOptions
,
)
:
any
Parameters
item
:
|
ObjectTypeDefinitionNode
|
InterfaceTypeDefinitionNode
|
InputObjectTypeDefinitionNode
|
ObjectTypeExtensionNode
|
InterfaceTypeExtensionNode
|
InputObjectTypeExtensionNode
mode
:
"class"
|
"interface"
options
:
DefinitionsGeneratorOptions
Returns
any
to
Property
Declaration
Structure
toPropertyDeclarationStructure
(
item
:
FieldDefinitionNode
|
InputValueDefinitionNode
,
options
:
DefinitionsGeneratorOptions
,
)
:
any
Parameters
item
:
FieldDefinitionNode
|
InputValueDefinitionNode
options
:
DefinitionsGeneratorOptions
Returns
any
to
Root
Schema
Definition
Structure
toRootSchemaDefinitionStructure
(
operationTypes
:
readonly
OperationTypeDefinitionNode
[]
,
mode
:
"class"
|
"interface"
,
)
:
any
Parameters
operationTypes
:
readonly
OperationTypeDefinitionNode
[]
mode
:
"class"
|
"interface"
Returns
any
to
Scalar
Definition
Structure
toScalarDefinitionStructure
(
item
:
ScalarTypeDefinitionNode
|
ScalarTypeExtensionNode
,
options
:
DefinitionsGeneratorOptions
,
)
:
TypeAliasDeclarationStructure
Parameters
item
:
ScalarTypeDefinitionNode
|
ScalarTypeExtensionNode
options
:
DefinitionsGeneratorOptions
Returns
TypeAliasDeclarationStructure
to
Union
Definition
Structure
toUnionDefinitionStructure
(
item
:
UnionTypeDefinitionNode
|
UnionTypeExtensionNode
,
options
:
DefinitionsGeneratorOptions
,
)
:
TypeAliasDeclarationStructure
Parameters
item
:
UnionTypeDefinitionNode
|
UnionTypeExtensionNode
options
:
DefinitionsGeneratorOptions
Returns
TypeAliasDeclarationStructure
unwrap
Type
If
Non
Null
unwrapTypeIfNonNull
(
type
:
TypeNode
)
:
{
required
:
boolean
;
type
:
TypeNode
}
Parameters
type
:
TypeNode
Returns
{
required
:
boolean
;
type
:
TypeNode
}
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Constructors
constructor
Methods
add
Symbol
If
Root
explore
get
Default
Types
get
Field
Type
Definition
get
Function
Parameters
get
Type
is
Root
to
Definition
Structures
to
Enum
Definition
Structure
to
Method
Declaration
Structure
to
Object
Type
Definition
Structure
to
Property
Declaration
Structure
to
Root
Schema
Definition
Structure
to
Scalar
Definition
Structure
to
Union
Definition
Structure
unwrap
Type
If
Non
Null
@vnodes/graphql
Loading...