graphql/language/source

Classes

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.

Constructor

Creates a Source instance.

Signature:

new Source(body: string, name: string, locationOffset: { line: number; column: number })

Arguments

Returns

Members

Functions

getLocation()

Takes a Source and a UTF-8 character offset, and returns the corresponding line and column as a SourceLocation.

Signature:

getLocation(source: Source, position: number): SourceLocation

Arguments

Returns

Example

import { Source, getLocation } from 'graphql/language';
 
const source = new Source('type Query { hello: String }');
const location = getLocation(source, 13);
 
// location: { line: 1, column: 14 }

printLocation()

Render a helpful description of the location in the GraphQL Source document.

Signature:

printLocation(location: Location): string

Arguments

Returns

Example

import { parse, printLocation } from 'graphql/language';
 
const document = parse('type Query { hello: String }');
const location = document.definitions[0].loc;
 
if (location) {
  const printed = printLocation(location);
 
  // printed:
  // GraphQL request:1:1
  // 1 | type Query { hello: String }
  //   | ^
}

printSourceLocation()

Render a helpful description of the location in the GraphQL Source document.

Signature:

printSourceLocation(source: Source, sourceLocation: SourceLocation): string

Arguments

Returns

Example

import { Source, printSourceLocation } from 'graphql/language';
 
const source = new Source('type Query { hello: String }');
const printed = printSourceLocation(source, { line: 1, column: 14 });
 
// printed:
// GraphQL request:1:14
// 1 | type Query { hello: String }
//   |              ^

Types

SourceLocation

Interface. Represents a location in a Source.

Members