Node API Helpers

The first argument passed to each of Gatsby’s Node APIs is an object containing a set of helpers. Helpers shared by all Gatsby’s Node APIs are documented in Shared helpers section.

Copycopy code to clipboard
// in gatsby-node.js
exports.createPages = gatsbyNodeHelpers => {
  const { actions, reporter } = gatsbyNodeHelpers
  // use helpers
}

Common convention is to destructure helpers right in argument list:

Copycopy code to clipboard
// in gatsby-node.js
exports.createPages = ({ actions, reporter }) => {
  // use helpers
}

Note

Some APIs provide additional helpers. For example createPages provides graphql function. Check documentation of specific APIs in Gatsby Node APIs for details.

Shared helpers