Skip to content

Docs: Explain where to get LintResultData in order to invoke ESLint.Formatter.format() #18821

Closed
@cowwoc

Description

Docs page(s)

https://eslint.org/docs/latest/integrate/nodejs-api#-loadedformatter-type

What documentation issue do you want to solve?

173e820#diff-cb681134e1d583c87b8a91a2dfbd4de0bfe5dd84fa3ee57efb5028d7bfeb5219R632 adds a required parameter to ESLint.format() called resultsMeta but the example given at https://eslint.org/docs/latest/integrate/nodejs-api#-loadedformatter-type is outdated and only passes in a single parameter.

What do you think is the correct solution?

Update the example. Show how where to get the second parameter from (does another API method return it? Is the user supposed to generate it?)

Participation

  • I am willing to submit a pull request for this change.

Additional comments

No response

Activity

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Assignees

Labels

acceptedThere is consensus among the team that this change meets the criteria for inclusioncoreRelates to ESLint's core APIs and featuresdocumentationRelates to ESLint's documentation

Type

No type

Projects

  • Status

    Complete

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions