README.md

graphql-edge

Execute GraphQL on the edge.

Installation

Install this library as dependency via your favorite package manager :)

$ [npm|yarn|pnpm] install graphql-edge

Usage

Following example works on Fastly Compute@Edge.

A GraphQL schema defines at schema.graphql:

type Book {
  id: Int!
  title: String!
}

type Query {
  books: [Book]!
}

And then server implementation is:

import { graphqlHandler } from "graphql-edge";
import schema from "../../_misc/schema.graphql";

addEventListener("fetch", (event: FetchEvent) => event.respondWith(handleRequest(event)));

// If you want to declare types with TypeScript, prefer to use graphql-codegen
const resolvers = {
  Query: {
    async books() {
      // Actually, we can send resolve request to Fastly Backend!
      return [
        { id: 1, title: "book01" },
        { id: 2, title: "book02" },
      ];
    }
  }
};

async function handleRequest(event: FetchEvent) {
  const { request } = event;
  const url = new URL(request.url);

  // Only handles /graphql pathname
  if (url.pathname === "/graphql") {
    const handler = graphqlHandler({
      typeDefs: schema,
      resolvers,
    });
    return handler(request);
  }
  return new Response("Not Found", { status: 404 });
}

Finally, the GraphQL query is:

query GetBooks {
  books {
    id
    title
  }
}

And run server and make request, then got response:

$ fastly compute serve
$ curl -v http://localhost:7676/graphql -H "Content-Type: application/graphql" -d @request.graphql
# => {"data":{"books":[{"id":1,"title":"book01"},{"id":2,"title":"book02"}]}}

See examples in detail:

• Fastly Compute@Edge
• Cloudflare Workers

Features

• TypeScript Support
• Works on Fastly Compute@Edge
• Works on Cloudflare Workers

Author

Yoshiaki Sugimoto [email protected]

License

MIT