GQLDocument

data class GQLDocument(definitions: List<GQLDefinition>, filePath: String?) : GQLNode

The top level node in a GraphQL document. This can be a schema document or an executable document (or something else if need be)

See parseAsGQLDocument for how to obtain a GQLDocument.

Constructors

GQLDocument

fun GQLDocument(definitions: List<GQLDefinition>, filePath: String?)

Types

Companion

object Companion

Functions

copyWithNewChildrenInternal

open override fun copyWithNewChildrenInternal(container: NodeContainer): GQLNode

Internal-only.

writeInternal

open override fun writeInternal(writer: SDLWriter)

Internal-only.

Properties

children

open override val children: List<GQLDefinition>

The children of this node.

definitions

val definitions: List<GQLDefinition>

filePath

val filePath: String?

sourceLocation

open override val sourceLocation: SourceLocation

Extensions

validateAsExecutable

@ApolloExperimental()

fun GQLDocument.validateAsExecutable(schema: Schema): GQLResult<List<GQLDefinition>>

Validates the given document as an executable document.

validateAsSchema

@ApolloExperimental()

fun GQLDocument.validateAsSchema(): GQLResult<Schema>

Validate the given document as a schema.
Add a schema definition if there is none
Merge type extensions

withApolloDefinitions

fun GQLDocument.withApolloDefinitions(): GQLDocument

withBuiltinDefinitions

fun GQLDocument.withBuiltinDefinitions(): GQLDocument

withBuiltinDirectives

fun GQLDocument.withBuiltinDirectives(): GQLDocument

withoutBuiltinDefinitions

fun GQLDocument.withoutBuiltinDefinitions(): GQLDocument

withoutBuiltinDirectives

fun GQLDocument.withoutBuiltinDirectives(): GQLDocument