Skip to content

Latest commit

 

History

History
57 lines (41 loc) · 1.11 KB

README.md

File metadata and controls

57 lines (41 loc) · 1.11 KB

Grapheetee

This module is a clean fetch based GraphQL client.

Usage

Once installed, the module exposes a constructor at the top-level that is ready to be instantiated in the browser:

import Grapheetee from "grapheetee";

const client = new Grapheetee({ url: "/api" });

Note that a base url must be supplied as an option to the constructor.

Node

Since the client is fetch based, libraries that provide these interfaces must be provided when the module is used on node. These details are handled automatically by providing a node ready version of the library:

const Grapheetee = require("grapheetee/node");

const instance = new Grapheetee({ url: "/my/internal/service" });

Requests

Requests are made by calling the query() or mutation() method on the client instance:

instance.query({
  query: "...",
  valariables: {
    /* optional */
  }
});

instance.mutation({
  query: "...",
  valariables: {
    /* optional */
  },
  uploads: [
    /* optional */
  ]
});

License

grapheetee is licensed under a standard 3-clause BSD license -- see the LICENSE-file for details.