Package Exports

@shopify/admin-graphql-api-utilities

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@shopify/admin-graphql-api-utilities) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

`@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

`parseGidType(gid: string): string`

Given a Gid string, parse out the type.

Example Usage

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

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

`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 parseGidWithParams(gid: string): ParsedGid`

Given a Gid string, parse out the id and its params.

Example Usage

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

parseGidWithParams('gid://shopify/Customer/12345?sessionId=123&foo=bar');
// → {
//     id: '12345',
//     params: {sessionId: '123', foo: 'bar'}
//   }

`function composeGidFactory(namespace: string): Function`

Create a new composeGid with a given namespace instead of the default shopify namespace.

Example Usage

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

const composeGid = composeGidFactory('CustomApp');

composeGid('Product', '123');
// → 'gid://CustomApp/Product/123'

`function composeGid(key: string, id: number | string, params: Record<string, 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', {foo: 'bar'});
// → 'gid://shopify/Customer/67890?foo=bar'

`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']