Skip to main content

Function: reportWithOptionalFix()

reportWithOptionalFix<MessageIds, Options>(__namedParameters: Readonly<{ context: Readonly<TSESLint.RuleContext<MessageIds, Options>>; data?: ReportDescriptor<MessageIds, Options>["data"]; fix: null | TSESLint.ReportFixFunction; messageId: MessageIds; node: TSESTree.Node; }>): void

Defined in: _internal/rule-reporting.ts:63

Report a diagnostic with an optional direct fix.

Type Parametersโ€‹

MessageIdsโ€‹

MessageIds extends string

Optionsโ€‹

Options extends readonly unknown[]

Parametersโ€‹

__namedParametersโ€‹

Readonly<{ context: Readonly<TSESLint.RuleContext<MessageIds, Options>>; data?: ReportDescriptor<MessageIds, Options>["data"]; fix: null | TSESLint.ReportFixFunction; messageId: MessageIds; node: TSESTree.Node; }>

Returnsโ€‹

void

Remarksโ€‹

When fix is absent this reports only messageId + node.