@graphql-tools/graphql
Version:
Fork of GraphQL.js
28 lines (27 loc) • 958 B
text/typescript
interface Location {
line: number;
column: number;
}
declare const isSourceSymbol: unique symbol;
/**
* 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.
*/
export declare class Source {
readonly [isSourceSymbol]: true;
body: string;
name: string;
locationOffset: Location;
constructor(body: string, name?: string, locationOffset?: Location);
get [Symbol.toStringTag](): string;
}
/**
* Test if the given value is a Source object.
*
* @internal
*/
export declare function isSource(source: unknown): source is Source;
export {};