Benzene Methods

The Benzene instance is not only used to create transport handlers but also to execute GraphQL queries just like the graphql-js library.

Instead of importing graphql, execute, subscribe from graphql-js. We can find them as the methods of Benzene. The API is the same as using the graphql exports from graphql-js, with the only difference that there is no schema since it is already defined upon creating the Benzene instance.

Methods

const GQL = new Benzene({ schema });

graphql()

Implementation of graphql from graphql-js.

const { data, errors } = await GQL.graphql({
  source: `
    query pokemon($id: ID!) {
      pokemon(id: $id) {
        name
        image
        abilities
      }
    }
  `,
  contextValue: { trainer: "Ash Ketchum", region: "Kanto" },
  variableValues: { id: 25 },
});

execute()

Implementation of execution from graphql-js.

import { parse } from "graphql";
 
const document = parse(`
  query pokemon($id: ID!) {
    pokemon(id: $id) {
      name
      image
      abilities
    }
  }
`);
 
const { data, errors } = await GQL.execute({
  document,
  contextValue: { trainer: "Ash Ketchum", region: "Kanto" },
  variableValues: { id: 25 },
});

subscribe()

Implementation of subscription from graphql-js.

import { parse } from "graphql";
 
const document = parse(`
  subscription pokemon($id: ID!) {
    pokemon(id: $id) {
      name
      image
      abilities
    }
  }
`);
 
const payload = await GQL.subscribe({
  document,
  contextValue: { trainer: "Ash Ketchum", region: "Kanto" },
  variableValues: { id: 25 },
});
 
for await (const value of payload) {
  console.log(value);
}

Query Compilation

Benzene speeds up GraphQL executions by doing the process of memoized compilation. This API can be accessed via the compile function. However, normally, we do not call this directly.

compile()

import { isExecutionResult } from "@benzene/core";
const compiled = GQL.compile(query, operationName);
 
if (isExecutionResult(compiled)) {
  // Compilation failed. `compiled` is an `ExecutionResult`.
  console.log(compiled.errors);
  console.log(compiled.data);
} else {
  compiled.execute();
  compiled.subscribe();
}

Provide compilation result

By calling graphql(), execute() or subscribe(), memoized compilations are done internally using GQL.compile. However, we can also pass in the optional compiled argument when available to skip this step.

import { isExecutionResult } from "@benzene/core";
 
const query = `
  query pokemon($id: ID!) {
    pokemon(id: $id) {
      name
      image
      abilities
    }
  }
`;
 
const compiled = GQL.compile(query, operationName);
 
if (isExecutionResult(compiled)) {
  console.log(compiled.data);
  console.log(compiled.errors);
} else {
  const { data, errors } = await GQL.execute({
    contextValue: { trainer: "Ash Ketchum", region: "Kanto" },
    variableValues: { id: 25 },
    compiled, // <- compiled is CompiledResult
    // document is not required in this case
  });
}

Be aware that it is possible for compiled to be an execution result so we must assert it before using.