https://github.com/borderless/worker-graphql

GraphQL server for worker environments (e.g. Cloudflare Workers)
https://github.com/borderless/worker-graphql

cloudflare-workers graphql graphql-server worker-graphql

Last synced: 2 months ago
JSON representation

GraphQL server for worker environments (e.g. Cloudflare Workers)

• Host: GitHub
• URL: https://github.com/borderless/worker-graphql
• Owner: borderless
• License: mit
• Created: 2020-01-12T01:33:50.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2023-12-12T06:41:51.000Z (about 1 year ago)
• Last Synced: 2024-11-01T06:42:26.758Z (3 months ago)
• Topics: cloudflare-workers, graphql, graphql-server, worker-graphql
• Language: TypeScript
• Size: 1.19 MB
• Stars: 34
• Watchers: 3
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Security: SECURITY.md

Awesome Lists containing this project

README

        
# Worker GraphQL

[![NPM version][npm-image]][npm-url]

[![NPM downloads][downloads-image]][downloads-url]

[![Build status][travis-image]][travis-url]

[![Test coverage][coveralls-image]][coveralls-url]

> GraphQL server for worker environments (e.g. Cloudflare Workers).

GraphQL on Workers was inspired by [this blog post](https://blog.cloudflare.com/building-a-graphql-server-on-the-edge-with-cloudflare-workers/), but using Apollo Server has a [massive bundle size](https://github.com/apollographql/apollo-server/issues/1572) or can't bundle due to dependency on `graphql-upload` (a node.js dependency). Using `worker-graphql` resulted in a build of < 50KB.

## Installation

```

npm install @borderless/worker-graphql --save

```

## Usage

```ts

import { processGraphQL } from "@borderless/worker-graphql";

import { makeExecutableSchema } from "graphql-tools";

const schema = makeExecutableSchema({

  typeDefs: `

    type Query {

      hello: String

    }

  `,

  resolvers: {

    Query: {

      hello: () => "Hello world!",

    },

  },

});

// Wrap `processGraphQL` with CORS support.

const handler = async (req: Request) => {

  if (req.method.toUpperCase() === "OPTIONS") {

    return new Response(null, {

      status: 204,

      headers: {

        "Access-Control-Allow-Methods": "GET,POST",

        "Access-Control-Allow-Headers":

          req.headers.get("Access-Control-Request-Headers") || "Content-Type",

        "Access-Control-Allow-Origin": "*",

      },

    });

  }

  const res = await processGraphQL(req, { schema });

  res.headers.set("Access-Control-Allow-Origin", "*");

  return res;

};

addEventListener("fetch", (event) => {

  event.respondWith(handler(event.request));

});

```

## License

MIT

[npm-image]: https://img.shields.io/npm/v/@borderless/worker-graphql.svg?style=flat

[npm-url]: https://npmjs.org/package/@borderless/worker-graphql

[downloads-image]: https://img.shields.io/npm/dm/@borderless/worker-graphql.svg?style=flat

[downloads-url]: https://npmjs.org/package/@borderless/worker-graphql

[travis-image]: https://img.shields.io/travis/borderless/worker-graphql.svg?style=flat

[travis-url]: https://travis-ci.org/borderless/worker-graphql

[coveralls-image]: https://img.shields.io/coveralls/borderless/worker-graphql.svg?style=flat

[coveralls-url]: https://coveralls.io/r/borderless/worker-graphql?branch=master