Before You File a Documentation Request Please Confirm You Have Done The Following...

• I have looked for existing open or closed documentation requests that match my proposal.
• I have read the FAQ and my problem is not listed.

Suggested Changes

The TypeOrValueSpecifier utility is used by a couple a few rules now:

• no-floating-promises: feat(eslint-plugin): [no-floating-promises] add option 'allowForKnownSafePromises' #9186 and feat(eslint-plugin): [no-floating-promises] add 'allowForKnownSafeCalls' option #9234
• prefer-readonly-parameter-types: feat(eslint-plugin): [prefer-readonly-parameter-types] added an optional type allowlist #4436

...and is pending for:

• no-unnecessary-type-parameters: Enhancement: [no-unnecessary-type-parameters] Add an option to treat types as "single-use" #9793
• restrict-template-expressions: feat: add allow option for restrict-template-expressions #8556 -> Enhancement: [restrict-template-expressions] More permissive type check #8722

We've been saying constantly that we want shared documentation for this thing. @abrahamguo's https://github.com/typescript-eslint/typescript-eslint/pull/8556/files#diff-3af7b11cfbfbd4c66519dff13130df296bdf564fbd1056765f1c79dbed9c2485 is a good start. We'll want to add a true docs page for it with the team's recommendations, including:

• All the things already mentioned in those docs
• To avoid using it as an allow option whenever possible (+ why)
• That there is a single string allowed format, but it's deprecated, and will likely eventually be removed (+ why)

Affected URL(s)

https://typescript-eslint.io/packages/type-utils/type-or-value-specifier, maybe?