@shopify/admin-graphql-api-utilities

@shopify/admin-graphql-api-utilities

A set of utilities to use when consuming Shopify’s admin GraphQL API.

Installation

$ yarn add @shopify/admin-graphql-api-utilities

API Reference

function parseGid(gid: string): string

Given a Gid string, parse out the id.

Example Usage

import {parseGid} from '@shopify/admin-graphql-api-utilities';

parseGid('gid://shopify/Customer/12345');
// → '12345'

function composeGid(key: string, id: number | string): string

Given a key and id, compose a Gid string.

Example Usage

import {composeGid} from '@shopify/admin-graphql-api-utilities';

composeGid('Customer', 12345);
// → 'gid://shopify/Customer/12345'

composeGid('Customer', '67890');
// → 'gid://shopify/Customer/67890'

function nodesFromEdges(edges)

Given an array of edges, return the nodes.

Example Usage

import {nodesFromEdges} from '@shopify/admin-graphql-api-utilities';

nodesFromEdges([
  {node: {id: '1', title: 'title one'}},
  {node: {id: '2', title: 'title two'}},
]);
// → [{id: '1', title: 'title one'}, {id: '2', title: 'title two'}]

function keyFromEdges(edges, key)

Given an array of edges, return a new array of only the specific key from those nodes.

Example Usage

import {keyFromEdges} from '@shopify/admin-graphql-api-utilities';

keyFromEdges(
  [
    {node: {id: '1', title: 'title one'}},
    {node: {id: '2', title: 'title two'}},
  ],
  'title',
);
// → ['title one', 'title two']