jsonapi-resolvers v2.0.0

jsonapi-resolvers

Build a resolving function to help you resolve JSON-API entities. With support for selecting specific fields & recursively include-ing related documents.

const { createResolver } = require('jsonapi-resolvers');
// Or
import { createResolver } from 'jsonapi-resolvers';

const resolve = createResolver({
  posts(ids) {
    // Fetch posts by ID in the JSONAPI format
  },
  users(ids) {
    // Fetch users by ID in the JSONAPI format
  },
});

// Fetch a single post by ID
const { data } = await resolve('posts', '1234');
// { data: { type: 'posts', id: '1234', ... } }

// Fetch multiple posts by ID
const { data } = await resolve('posts', ['1234', '5678']);
// { data: [
//    { type: 'posts', id: '1234', ... },
//    { type: 'posts', id: '5678', ... } ] }

// Fetch a single post by ID, including users too
const { data } = await resolve('posts', '1234', {
  include: ['author'],
});
// { data: { type: 'posts', id: '1234', ... },
//   included: [ { type: 'users', id: 'abcd' } ]}

// Fetch multiple posts by ID, including users too
const { data } = await resolve('posts', ['1234', '5678']);
// { data: [
//    { type: 'posts', id: '1234', ... },
//    { type: 'posts', id: '5678', ... } ],
//   included: [ { type: 'users', id: 'abcd' } ]}

Install

$ npm install jsonapi-resolvers
# or
$ yarn add jsonapi-resolvers

API

createResolver(fetchers, opts?) => resolve

Create a resolve function for a set of types.

• Description of Resolve functions

resolve(type, id, opts?)

Notes

• For more information on the JSONAPI specification, please see here.
• Questions? Please open an issue.