Skip to content

fix(gatsby): add this typings to actions#32210

Merged
wardpeet merged 2 commits into
gatsbyjs:masterfrom
alvis:fix/types/bounded-helpers
Aug 27, 2021
Merged

fix(gatsby): add this typings to actions#32210
wardpeet merged 2 commits into
gatsbyjs:masterfrom
alvis:fix/types/bounded-helpers

Conversation

@alvis
Copy link
Copy Markdown
Contributor

@alvis alvis commented Jul 2, 2021

Description

Commonly, we destruct the action field as well as other helper functions from the API argument like this:

const {
  actions: { createNode, deleteNode },
  createContentDigest,
  createNodeId,
  reporter,
} = args;

These functions are bounded and it's 100% safe to invoke these functions since they do not access this.
However, the current type file doesn't explicitly state that and hence would trigger a warning from some linting tools such as @typescript-eslint/unbound-method

This PR declares it explicitly and therefore avoid unnecessary warnings
See https://github.com/typescript-eslint/typescript-eslint/blob/v4.28.0/packages/eslint-plugin/docs/rules/unbound-method.md

@gatsbot gatsbot Bot added the status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer label Jul 2, 2021
@alvis
Copy link
Copy Markdown
Contributor Author

alvis commented Aug 11, 2021

ping @wardpeet @LekoArts @KyleAMathews @pieh 🥺

Copy link
Copy Markdown
Contributor

@wardpeet wardpeet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks, looks great! Sorry for the wait!

@wardpeet wardpeet changed the title fix(gatsby): hint that helpers are bounded fix(gatsby): add this typings to actions Aug 27, 2021
@wardpeet wardpeet added topic: TypeScript Issues and PRs related to TS in general, public typings or gatsby-plugin-typescript and removed status: triage needed Issue or pull request that need to be triaged and assigned to a reviewer labels Aug 27, 2021
@wardpeet wardpeet added the bot: merge on green Gatsbot will merge these PRs automatically when all tests passes label Aug 27, 2021
@wardpeet wardpeet merged commit cf9c066 into gatsbyjs:master Aug 27, 2021
This was referenced Aug 31, 2021
raffishquartan pushed a commit to raffishquartan/gatsby that referenced this pull request Apr 28, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

bot: merge on green Gatsbot will merge these PRs automatically when all tests passes topic: TypeScript Issues and PRs related to TS in general, public typings or gatsby-plugin-typescript

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants