docs: Remove note about stringified options

[CanRau]

I'm not entirely sure about this, I'm aware of the origin #3987 yet this PR I made proofs the opposite #12060
Only thing I can think of right now that browser APIs get stringified, couldn't verify this so far, this #3834 is suggesting they get stringified and it's the reason the note was added to the docs in the first place..

Couldn't just leave my confusion alone and thought doing it in a PR might be useful if it's actually not valid anymore so it can be merged directly, otherwise feel free to reject it of course 👍

Description

Related Issues

[pieh]

Browser APIs options get JSON.stringified (

gatsby/packages/gatsby/src/bootstrap/index.js

Line 313 in 9f0835a

options: ${JSON.stringify(plugin.options)},

)
and SSR APIs options get JSON.stringified (

gatsby/packages/gatsby/src/bootstrap/index.js

Line 333 in 9f0835a

options: ${JSON.stringify(plugin.options)},

)

Node APIs are not getting stringified because they executed in the same context, so they are just used from memory as they are

[CanRau]

Okay, good to know, thanks for clarifying 🙏
Then the note either stays or could get an update like

Note that plugin options of gatsby-ssr.js and gatsby-browser.js get stringified by Gatsby, so they cannot be functions.

But maybe it's not the right place 🤔 I think it's a little bit misleading as they can be in certain cases..
What do you think?

[sidharthachatterjee]

@CanRau While like @pieh correctly mentioned, options do indeed get stringified in case of gatsby-ssr and gatsby-browser, in the context of this doc, it's okay to remove the note since

• It's not always true
• It's not relevant to the user reading this

Merging this in! Thank you 👍

[mike1808]

I was trying to pass function for gatsby-browser and I faced this issue. I think, it's worth mentioning in the docs that options for ssr and browser are stringified and you cannot pass functions.

[abumalick]

I think it is worth mentioning somewhere in the plugin docs too.

I don't know in which section it would fix through

https://www.gatsbyjs.org/docs/creating-plugins/