⬅️ Back to Table of Contents

📄 getFixOrSuggest

📊 Analysis Summary

Metric	Count
🔧 Functions	1
📦 Imports	1

📚 Table of Contents

• Imports
• Functions

🛠️ File Location:

📂 packages/eslint-plugin/src/util/getFixOrSuggest.ts

📦 Imports

Name	Source
TSESLint	@typescript-eslint/utils

---

Functions

getFixOrSuggest({ fixOrSuggest, suggestion, }: { fixOrSuggest: 'fix' | 'none' | 'sugge…): | { fix: TSESLint.ReportFixFunction } | { suggest: TSESLint…

Parameters:

• { fixOrSuggest, suggestion, } { fixOrSuggest: 'fix' | 'none' | 'suggest'; suggestion: TSESLint.SuggestionReportDescriptor<MessageId>; }

Returns: | { fix: TSESLint.ReportFixFunction } | { suggest: TSESLint.SuggestionReportDescriptor<MessageId>[] } | undefined

Code

export function getFixOrSuggest<MessageId extends string>({
  fixOrSuggest,
  suggestion,
}: {
  fixOrSuggest: 'fix' | 'none' | 'suggest';
  suggestion: TSESLint.SuggestionReportDescriptor<MessageId>;
}):
  | { fix: TSESLint.ReportFixFunction }
  | { suggest: TSESLint.SuggestionReportDescriptor<MessageId>[] }
  | undefined {
  switch (fixOrSuggest) {
    case 'fix':
      return { fix: suggestion.fix };
    case 'none':
      return undefined;
    case 'suggest':
      return { suggest: [suggestion] };
  }
}

---

Generated by Syntax Scribe