sitespeedio / sitespeedio/browsertime

Proper typescript types

Open
#2,169 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
652
Forks
141
Avg merge
3h 56m
Merged PRs (30d)
5

Description

Feature/improvement

Can you please add proper typescript types? The current ones are not usable, e.g.:

image

Function as type is just saying nothing. No return type, no arguments.

This should be (url: string) => Promise<void>.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by locating the current TypeScript type declarations and the APIs that use the generic Function type. Review how those APIs are exported and identify the argument and return types that can be specified from their behavior. Done means the affected public types expose usable parameter and return types instead of Function.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript, typescript
Domain
developer-experience
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.