Function parseQueryToSteps

packages/graph/src/index.ts:145–160

(
  queryString: string,
  options?: ParseQueryToStepsOptions,
)

 * @param options.readonly When true, throws ReadonlyGraphError if the query contains mutation steps.
 */
export function parseQueryToSteps(
  queryString: string,
  options?: ParseQueryToStepsOptions,
): {
  steps: readonly Step<any>[];
  postprocess: (row: readonly unknown[]) => Record<string, unknown>;
} {
  const ast = parse(queryString) as Query | UnionQuery | MultiStatement;
  const steps = anyAstToSteps(ast);

  if (options?.readonly) {
    validateNoMutations(steps);
  }

  return { steps, postprocess: createPostprocessor(ast) };
}

/**
 * Creates a function which takes the array of values returned by the graph traversal