Microsoft/TypeScript

`Date.getVarDate()` function seems incorrectly defined

Open

#51,636 opened on Nov 24, 2022

View on GitHub
 (1 comment) (0 reactions) (0 assignees)TypeScript (48,455 stars) (6,726 forks)batch import
BugDomain: lib.d.tsHelp Wanted

Description

interface Date {
    getVarDate: () => VarDate;
}

https://contest-server.cs.uchicago.edu/ref/JavaScript/developer.mozilla.org/en-US/docs/Web/JavaScript/Microsoft_Extensions/Date.html

TypeScript has defined Date type to has a functional property getVarDate, but such function does not exist in the real Date instance. Looking at some API documents, the Date.getVarDate() is a non-standard method forActiveX. Therefore, I hope TypeScript to remove the functional property or change it like below:

interface Date {
    // no reason to be property assigned functional value
    getVarDate?(): VarDate;
}

Contributor guide

Tech stack
typescript
Domain
developer experiencetooling
Issue type
bug
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
1
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
under 1 hour
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
clear
Prerequisites
basic TypeScript knowledgefamiliarity with lib.d.ts definitions
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
90
Research direction
The issue proposes making the getVarDate method optional in TypeScript's Date interface, which is defined in lib.es5.d.ts. First, confirm the method is non standard and only used for ActiveX. Then, locate the Date interface definition in the TypeScript source (likely src/lib/es5.d.ts) and change the property declaration to optional using ?:. Finally, run the TypeScript test suite to ensure no regressions.