blob: 961205a2cf67fd0c23c6719734a34f305cfc89a2 [file] [log] [blame]
// @flow strict
import { SYMBOL_TO_STRING_TAG } from '../polyfills/symbols';
import devAssert from '../jsutils/devAssert';
type Location = {|
line: number,
column: number,
|};
/**
* A representation of source input to GraphQL.
* `name` and `locationOffset` are optional. 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: 0 }`.
* line and column in locationOffset are 1-indexed
*/
export class Source {
body: string;
name: string;
locationOffset: Location;
constructor(
body: string,
name: string = 'GraphQL request',
locationOffset: Location = { line: 1, column: 1 },
): void {
this.body = body;
this.name = name;
this.locationOffset = locationOffset;
devAssert(
this.locationOffset.line > 0,
'line in locationOffset is 1-indexed and must be positive.',
);
devAssert(
this.locationOffset.column > 0,
'column in locationOffset is 1-indexed and must be positive.',
);
}
// $FlowFixMe Flow doesn't support computed properties yet
get [SYMBOL_TO_STRING_TAG]() {
return 'Source';
}
}