chore(docs): Update documentation for createNodeField #24740
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
gatsbot
bot
added
the
status: triage needed
freiksenet
changed the title
vladar
reviewed
Jun 3, 2020
| @@ -963,7 +963,7 @@ type CreateNodeInput = { | |||
| * @param {string} $0.fieldName [deprecated] the name for the field | |||
| * @param {string} $0.fieldValue [deprecated] the value for the field | |||
| * @param {string} $0.name the name for the field | |||
| * @param {string} $0.value the value for the field | |||
| * @param {any} $0.value the value for the field | |||
There was a problem hiding this comment.
I think we actually sanitize it to this set of types:
gatsby/packages/gatsby/src/db/sanitize-node.js
Lines 62 to 75 in 2b578e8
Not sure if we should change any to this union though
There was a problem hiding this comment.
On the other hand they can pass anything here indeed. It will be simply stripped away unless it's null | number | string | boolean | Date
There was a problem hiding this comment.
It can also be a plain object or array.
vladar
approved these changes
Jun 3, 2020
vladar
added
type: documentation
freiksenet
added
the
bot: merge on green
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Value can be anything, not just string.
Closes #23852