Skip to content

kamilkisiela/graphql-config

Folders and files

NameName
Last commit message
Last commit date

Latest commit

dbc58bc · Mar 25, 2020
Mar 25, 2020
Oct 24, 2019
Mar 25, 2020
Aug 4, 2016
Mar 25, 2020
Mar 25, 2020
Mar 25, 2020
Oct 25, 2019
Oct 24, 2019
Mar 25, 2020
Sep 26, 2019
Oct 24, 2019
Jul 29, 2016
Nov 4, 2019
Oct 24, 2019
Mar 25, 2020
Mar 25, 2020
Mar 25, 2020
Oct 24, 2019
Mar 25, 2020

Repository files navigation

GraphQL Config

GraphQL Config

The easiest way to configure your development environment with your GraphQL schema (supported by most tools, editors & IDEs).

GraphQL Config file

schema: ./schema.json
documents: ./src/components/**/*.jsx

Usage

Install:

  yarn add graphql-config
  npm install graphql-config

Use:

Very basic outline in TypeScript:

import {loadConfig} from 'graphql-config';

async function main() {
  const config = await loadConfig({...});

  const schema = await config.getDefault().getSchema();
}

The ... expression in the loadConfig function is a placeholder for a LoadConfigOptions object; leaving this space empty will pass defaults.

Here is a more robust, working example using a generate extension from the GraphQL CLI Backend Template:

const config = await loadConfig({
    extensions: [() => ({ name: 'generate'})]
});

const generateConfig = await config!.getDefault().extension('generate');

...
  
const schema = makeExecutableSchema({
    typeDefs,
    resolvers
});

Help & Community Discord Chat

Join our Discord chat if you run into issues or have questions. We love talking to you!