Skip to main content

Source

A representation of source input to GraphQL. The name and locationOffset parameters are optional, but they are useful for clients who store GraphQL documents in source files. For example, if the GraphQL input starts at line 40 in a file named Foo.graphql, it might be useful for name to be "Foo.graphql" and location to be { line: 40, column: 1 }. The line and column properties in locationOffset are 1-indexed.

Index

Constructors

Properties

Accessors

Constructors

constructor

  • new Source(body: string, name?: string, locationOffset?: Location): Source
  • Parameters

    • body: string
    • name: string = 'GraphQL request'
    • locationOffset: Location = ...

    Returns Source

Properties

body

body: string

locationOffset

locationOffset: Location

name

name: string

Accessors

[toStringTag]

  • get [toStringTag](): string
  • Returns string