Numbers Produce Meaning

    gatsby-node-helpers
    TypeScript icon, indicating that this package has built-in type declarations

    1.2.1 • Public • Published

    gatsby-node-helpers

    Gatsby node helper functions to aid node creation. To be used when creating Gatsby source plugins.

    • Automatically adds Gatsby's required node fields such as contentDigest
    • Namespaces fields conflicting with Gatsby's reserved fields
    • Creates portable functions for generating compliant type names and IDs

    Status

    npm version Build Status

    Installation

    npm install --save gatsby-node-helpers
    

    Quick Guide

    Import the named module:

    import { createNodeHelpers } from 'gatsby-node-helpers'

    Then call createNodeHelpers with options. You will need to pass functions available in Gatsby's Node APIs, such as sourceNodes and createSchemaCustomization.

    The following example shows usage in gatsby-node.js's sourceNodes API, but it can be used elsewhere provided the appropriate helper functions are available.

    // gatsby-node.ts
    
    import * as gatsby from 'gatsby'
    import { createNodeHelpers } from 'gatsby-node-helpers'
    
    export const sourceNodes: gatsby.GatsbyNode['sourceNodes'] = async (
      gatsbyArgs: gatsby.SourceNodesArgs,
      pluginOptions: gatsby.PluginOptions,
    ) => {
      const { createNodeId, createContentDigest } = gatsbyArgs
    
      const nodeHelpers = createNodeHelpers({
        typePrefix: 'Shopify',
        createNodeId,
        createContentDigest,
      })
    }

    The result of createNodeHelpers includes a factory function named createNodeFactory that should be used to prepare an object just before calling Gatsby's createNode.

    The created function will automatically assign Gatsby's required fields, like internal and contentDigest, while renaming any conflicting fields.

    const nodeHelpers = createNodeHelpers({
      typePrefix: 'Shopify',
      createNodeId: gatsbyArgs.createNodeId,
      createContentDigest: gatsbyArgs.createContentDigest,
    })
    
    const ProductNode = nodeHelpers.createNodeFactory('Product')
    const ProductVariantNode = nodeHelpers.createNodeFactory('ProductVariant')

    In the above example, we can now pass Product objects to ProductNode to prepare the object for Gatsby's createNode.

    // gatsby-node.ts
    
    import * as gatsby from 'gatsby'
    import { createNodeHelpers } from 'gatsby-node-helpers'
    
    export const sourceNodes: gatsby.GatsbyNode['sourceNodes'] = async (
      gatsbyArgs: gatsby.SourceNodesArgs,
      pluginOptions: gatsby.PluginOptions,
    ) => {
      const { actions, createNodeId, createContentDigest } = gatsbyArgs
      const { createNodes } = actions
    
      const nodeHelpers = createNodeHelpers({
        typePrefix: 'Shopify',
        createNodeId,
        createContentDigest,
      })
    
      const ProductNode = nodeHelpers.createNodeFactory('Product')
      const ProductVariantNode = nodeHelpers.createNodeFactory('ProductVariant')
    
      // `getAllProducts` is an API function that returns all Shopify products.
      const products = await getAllProducts()
    
      for (const product of products) {
        const node = ProductNode(product)
    
        // `node` now contains all the fields required by `createNode`.
    
        createNode(node)
      }
    }

    API

    All functions and types are documented in the source files using TSDoc to provide documentation directly in your editor.

    If you editor does not have TSDoc integration, you can read all documentation by viewing the source files.

    Install

    npm i gatsby-node-helpers

    DownloadsWeekly Downloads

    28,873

    Version

    1.2.1

    License

    MIT

    Unpacked Size

    58.9 kB

    Total Files

    17

    Last publish

    Collaborators

    • angeloashmore