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 (17 forks)user submission
enhancementhelp wanted

Repository metrics

Stars
 (447 stars)
PR merge metrics
 (No merged PRs in 30d)

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

Research direction
Investigate the TypeScript issue #33185 and previous PR #31 to understand the overload and generic constraints, then explore conditional types or helper types to inherit querySelector's types without copying.
Tech stack
typescriptjavascript
Domain
frontend
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.
Half day
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Fresh
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
TypeScript
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
30