microsoft / microsoft/TypeScript

Assign existing interface to global (globalThis)

Open
#57,353 1 comment 8 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Awaiting More Feedback Suggestion
Dominant language
Go
Stars
111k
Forks
14.3k
Avg merge
1d 19h
Merged PRs (30d)
117

Description

🔍 Search Terms
  • global
  • globalThis
  • window
✅ Viability Checklist
⭐ Suggestion

Currently, to provide types to globalThis, I can update the global.d.ts similar to:

declare global {
    interface Navigator {
        ...
    }
}

However, if I want to set the interface of the global object (e.g. to give it the an interface that extends theWindow interface, I'd have to do something like this at the top of each .ts file that references globalThis like the below:

interface MyWindow extends Window {}

declare let globalThis: MyWindow;

I'd like to see a way where I can modify the whole interface of the global object.

📃 Motivating Example

Override the whole ` interface.

💻 Use Cases

Working across multiple runtimes which share the same global interface without having a large global.d.ts with copy/pasted interfaces from utility types.

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 reviewing the global.d.ts and declare global examples in the issue, along with the proposed globalThis declaration. Determine how an interface for the whole global object should be modified across multiple runtimes, and define completion as a supported, non-breaking declaration approach with its behavior covered by appropriate tests.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.