Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

2.0.0-rc.3 documentation on formatText overloads is wrong #4078

Closed
justinbhopper opened this issue Mar 23, 2024 · 2 comments · Fixed by #4086
Closed

2.0.0-rc.3 documentation on formatText overloads is wrong #4078

justinbhopper opened this issue Mar 23, 2024 · 2 comments · Fixed by #4086
Labels
bug:types issues that are only related to declarations

Comments

@justinbhopper
Copy link
Contributor

justinbhopper commented Mar 23, 2024

Currently the docs show overloads for formatText that no longer exist. It seems formatText has gone through changes where it no longer supports passing in multiple formats at once, although the underlying call to the Editor does. I would think maybe the solution is to restore these overloads, since it's nice to be able to reduce the number of events that occur when multi-formatting needs to happen together.

image

https://github.com/quilljs/quill/blob/v2.0.0-rc.3/packages/quill/src/core/quill.ts#L381-L393

2.0.0-rc.3

I couldn't find any open Issues suggesting that the website docs are intentionally stale, so I wanted to report this. The TypeScript declarations are obviously reliable, so it's only an issue for consumers using native JS.

@shareefalis
Copy link

It still works, i can confirm. I just do // @ts-expect-error. This needs to be fixed.

@luin
Copy link
Member

luin commented Mar 25, 2024

Seems like a declaration issue. Haven't looked into it but I think we want to keep the overload variant. Will take a look.

@luin luin added the bug:types issues that are only related to declarations label Mar 25, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug:types issues that are only related to declarations
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants