sindresorhus/element-ready

Use types directly from querySelector, without copying them

Open

#32 opened on Dec 29, 2020

View on GitHub
 (0 comments) (2 reactions) (0 assignees)JavaScript (447 stars) (17 forks)user submission
enhancementhelp wanted

Description

If the selector is 'a', querySelector‘s return type is be HTMLAnchorElement. To achieve the same in element-ready, we had to manually copy its types and adapt them to elementReady

Ideally, instead, we should try to “inherit” directly from the global querySelector so that, if its types are enhanced (via typed-query-selector or natively), element-ready automatically gets upgraded.

Note: We can't use Parameters<typeof querySelector> and such because it doesn't support overloads nor generics.

This has been unsuccessfully tried in #31. More info about it in that PR. A possible solution might be https://github.com/microsoft/TypeScript/issues/33185#issuecomment-526969274

Contributor guide

Tech stack
typescriptjavascript
Domain
developer experience
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
TypeScript genericsUnderstanding of querySelector types
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
50
Research direction
Review the previous attempt in PR #31 to understand why it failed. Explore the suggested solution from the TypeScript issue comment (microsoft/TypeScript#33185). Investigate if 'typed query selector' can be integrated or if native TypeScript improvements (issue #29037) can be leveraged. Look at the current type definitions in the element ready package to see how types are copied and how they could be inherited from global querySelector.