Promise<FrozenArray<T>> should become Promise<sequence<T>>
Nobody has claimed this yet.
- Dominant language
- Bikeshed
- Stars
- 3.6k
- Forks
- 324
- Avg merge
- 14d 22h
- Merged PRs (30d)
- 1
Description
A few methods, namely:
Clients'smatchAll()Cache'smatchAll()andkeys()ServiceWorkerContainer'sgetRegistrations()
return Promise<FrozenArray<T>>.
As discussed in https://github.com/whatwg/webidl/issues/1399, it doesn't really make sense to return frozen arrays as return values. The caller should just get back a sequence<T>.
It would be nice to clean this up so that the Web IDL spec can disallow using FrozenArray<T> in such scenarios.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by locating the Service Worker specification definitions for Clients.matchAll(), Cache.matchAll(), Cache.keys(), and ServiceWorkerContainer.getRegistrations(). Compare their Promise return types with the Web IDL discussion in issue 1399, then update the affected declarations so they use sequence and verify that these methods no longer return FrozenArray.
Written by the indexing model from the issue text.
Assessment
- Domain
- documentation
- Issue type
- Refactor
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100