microsoft / microsoft/TypeScript

Add readonly for all possible function parameter for lib.dom.d.ts

Open
#38,258 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Bug Domain: lib.d.ts
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
2d 4h
Merged PRs (30d)
132

Description

Search Terms

library, dom

Suggestion

Add readonly for all possible function parameter for lib.dom.d.ts

Examples

Here is an example for add readonly props for constructor:

declare var URLSearchParams: {
    prototype: URLSearchParams;
    new(init?: string[][] | Record<string, string> | string | URLSearchParams): URLSearchParams;
    toString(): string;
};

It should be

declare var URLSearchParams: {
    prototype: URLSearchParams;
    new(init?: ReadonlyArray<readonly [string,string]> | Readonly<Record<string, string>> | string | URLSearchParams): URLSearchParams;
    toString(): string;
};

then I can use

const myGlobalConfig = {
    myURLSearchParamsInit1: [['foo','bar']],
    myURLSearchParamsInit2: {foo:'bar'}
} as const;
const params = new URLSearchParams(myGlobalConfig.myURLSearchParamsInit1)

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 reading the lib.dom.d.ts URLSearchParams declaration and compare its constructor parameter types with the readonly example in the issue. Determine which other function parameters are eligible and how broadly the change should apply. Done means the relevant lib.dom.d.ts declarations consistently accept readonly inputs without changing their intended API.

Written by the indexing model from the issue text.

Assessment

Tech stack
typescript
Domain
compilers
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.