document helper functions passed to gatsby-node APIs

[chmac]

Description

I have a collection of markdown files that I'd like to become blog posts. In the course of trying to figure out how to filter by folder, I came across getNode() in various code samples, but I can't find anything about it the docs. It seems to be a part of the boundActionCreators inside onCreateNode, but I'm not 100% sure of that.

Can we add it to the docs? I'm happy to have a bash if somebody can point me the right direction.

EDIT: I realise that getNode looks like a sibling of boundActionCreators rather than a child of it.

[m-allanson]

@chmac Yes please, 👍 for additional docs.

getNode is defined here.

There's actually a bunch of helpers that get passed in to each gatsby-node.js API call. If you wanted to document any of those or just add placeholders, that'd be 👍 too.

Maybe this should be another page in the reference section of the docs, called Gatsby Node Utils? @KyleAMathews might have a better idea on where this should go and what to call it.

If the docs were to go in the reference section, you'd add a markdown file to the docs folder, and then reference it in doc-links.yaml.

Don't hesitate to ask questions at any point!

[KyleAMathews]

Yeah, we need a docs page for all the utils. We should build it like the other reference docs pages like adding jsdocs section to each utility and then querying them to create the page.

[vprasanth]

Hi folks, I'd be happy to help with this effort as well.

[m-allanson]

Good stuff @vprasanth!

gatsby-node.js API calls have the following args passed in by default:

• pathPrefix from store (if available)

• boundActionCreators from src/redux/actions.js

• store, loadNodeContent, getNodes, getNode, hasNodeChanged, getNodeAndSavePathDependency from src/redux/index.js

• reporter from gatsby-cli/lib-reporter/index.js

• createNodeId from src/utils/create-node-id.js

• cache from src/utils/cache.js

@KyleAMathews What's the best way to document these? Should there be a reference page for the methods in src/redux/index.js? And then a separate reference page for anything from src/utils/* that should be documented?

[KyleAMathews]

It's best to have functions documented where they're defined. So let's add jsdocs comments there then when we create the page, we can query directly for the docs for the names of the functions we need

gatsby/www/src/pages/docs/bound-action-creators.js

Line 65 in c68d311

query ActionCreatorDocsQuery {

[KyleAMathews]

Thanks for jumping in to help @vprasanth! This has needed done for a while now 😅

[vprasanth]

Alright great, I think I understand. Thanks @m-allanson for doing that leg work :) I'll give it a shot tonight.

[vprasanth]

cc @KyleAMathews @m-allanson

Hey can someone take a quick look at this and let me know if I'm going generally in the right direction:

master...vprasanth:issue-4120

Thanks!

[KyleAMathews]

Looking good! Keep going and put a PR any time.

[m-allanson]

Thanks to @vprasanth for adding jsdocs for these methods. Reopening as the docs could still be exposed as part of gatsbyjs.org. See #4120 (comment)