Readme example has type error

[nvlang]

Initial checklist

• I read the support docs
• I read the contributing guide
• I agree to follow the code of conduct
• I searched issues and couldn’t find anything (or linked relevant results below)

Affected packages and versions

[email protected]

Link to runnable example

https://stackblitz.com/edit/github-8eeglc?file=src%2Fmain.ts

Steps to reproduce

1. Go to minimal reproduction
2. Run tsc

Expected behavior

No type errors.

Actual behavior

The following error is logged:

src/main.ts:12:22 - error TS2345: Argument of type '[Processor<Root, Root, undefined, undefined, undefined>]' is not assignable to parameter of type '[boolean] | [parser: Parser, options?: Options | null | undefined]'.
  Type '[Processor<Root, Root, undefined, undefined, undefined>]' is not assignable to type '[boolean]'.
    Type 'Processor<Root, Root, undefined, undefined, undefined>' is not assignable to type 'boolean'.

12   .use(remarkRetext, unified().use(retextEnglish).use(retextEquality))

Runtime

No response

Package manager

No response

OS

No response

Build and bundle tools

No response

[ChristianMurphy]

TypeScript isn't capable of inferring this type yet.
Add an // @ts-expect-error annotation.

remark-retext/test.js

Lines 38 to 39 in 4395bc6

	// @ts-expect-error: TS barfs on overloads that result in bridges.
	.use(remarkRetext, unified().use(retextEnglish))

If there has been a recent improvement to TS which would enable this, feel free to share an example of that working.

[wooorm]

Looked into it again — Doesn’t seem anything changed in TS to support both the overloads.