0.1.1 • Published 6 years ago

fakeql-loader v0.1.1

Weekly downloads
6
License
MIT
Repository
github
Last release
6 years ago

fakeql-loader

A Webpack loader for FakeQL

Install

$ npm install fakeql-loader --save-dev

Usage

This loader is made for already extended JSON files. Extending on the fly makes no sense with a Webpack loader, as the output would be different each run. You can extend your JSON directly on FakeQL or locally with Blowson. The loader will make a new deployment and return a new hash on every change of the JSON file. To make sure no other loaders interfer with this process, we've choosen the .fakeql file extension.

Usage with preconfigured loader

webpack.config.js

// webpack.config.js
module.exports = {
  entry: './index.js',
  output: {
    /* ... */
  },
  module: {
    loaders: [
      {
        // make all files ending in .fakeql use the `fakeql-loader`
        test: /\.fakeql$/,
        loader: 'fakeql-loader',
      },
    ],
  },
};
// index.js
const blogAPIhash = require('./extended-blog-sample-data.fakeql');
// or, in ES6
// import blogAPIhash from './extended-blog-sample-data.fakeql'

console.log(blogAPIendpoint); // 'b3b930ee57add5b17d2c9dd503029072'

Where your extended JSON is saved in a file with the name extended-blog-sample-data.fakeql.

Usage with require statement loader prefix

const blogAPIhash = require('fakeql-loader!./extended-blog-sample-data.fakeql');

console.log(appConfig); // 'b3b930ee57add5b17d2c9dd503029072'

Both ways you get the hash of the API back (or false if anything fails), so you than can use it for example like this (with Apollo):

const client = new ApolloClient({
  uri: `https://fakeql.com/graphql/${blogAPIhash}`
});

Behaviour

The FakeQL Webpack loader will automatically create a new deployment of your sample data whenever the sample file changes and return the hash of the new deployment.