Skip to content

Add Intl.PluralRules to DOM types #23691

Closed
Closed
Add Intl.PluralRules to DOM types#23691
Labels
BugA bug in TypeScriptDomain: lib.d.tsThe issue relates to the different libraries shipped with TypeScriptFixedA PR has been merged for this issueHelp WantedYou can do this
Milestone
TypeScript 2.9

Description

@dsifford
Derek Sifford (dsifford)
opened on Apr 25, 2018

TypeScript Version: 2.8.3

Search Terms:

  • Intl.PluralRules
  • Intl
  • pluralrules

(searched all issues, the wiki, the code, google, and stackoverflow)

Code

const plurals = new Intl.PluralRules(); // error: Property 'PluralRules' does not exist on type 'typeof Intl'.

Gist:

Intl.PluralRules is at Stage 4 and is supported by most browsers. In addition, there is a TC39 polyfill that exists for older browsers. I'd expect this now to exist in the DOM type definitions.

Expected behavior: Intl.PluralRules to be defined.

Actual behavior: Intl.PluralRules isn't defined anywhere. (I actually even took it one further and ripgrepped the entire repository for PluralRules and there were 0 matches.)

Playground Link: N/A

Related Issues: None that I could locate.

Activity

  1. Mohamed Hegazy (mhegazy)
    added
    BugA bug in TypeScript
    Help WantedYou can do this
    on Apr 25, 2018
  2. Mohamed Hegazy (mhegazy)
    added this to the milestone on Apr 25, 2018
  3. Mohamed Hegazy (mhegazy)
    added
    Domain: lib.d.tsThe issue relates to the different libraries shipped with TypeScript
    on Apr 25, 2018

  4. mhegazy commented on Apr 25, 2018

    @mhegazy
    Mohamed Hegazy (mhegazy)
    on Apr 25, 2018
    Contributor

    PRs welcomed. I think we can add that to lib.es2018.intl.d.ts. see https://github.com/Microsoft/TypeScript/blob/master/src/lib/es2017.intl.d.ts for example.

  5. dsifford commented on Apr 25, 2018

    @dsifford
    Derek Sifford (dsifford)
    on Apr 25, 2018
    ContributorAuthor

    For those who need this right now:

    declare namespace Intl {
    interface PluralRulesOptions {
        localeMatcher?: 'lookup' | 'best fit';
        type?: 'cardinal' | 'ordinal';
    }

    interface ResolvedPluralRulesOptions {
        locale: string;
        pluralCategories: string[];
        type: 'cardinal' | 'ordinal';
        minimumIntegerDigits: number;
        minimumFractionDigits: number;
        maximumFractionDigits: number;
        minimumSignificantDigits: number;
        maximumSignificantDigits: number;
    }

    interface PluralRules {
        resolvedOptions(): ResolvedPluralRulesOptions;
        select(n: number): string;
    }

    const PluralRules: {
        new (locales?: string | string[], options?: PluralRulesOptions): PluralRules;
        (locales?: string | string[], options?: PluralRulesOptions): PluralRules;
        supportedLocalesOf(
            locales: string | string[],
            options?: PluralRulesOptions,
        ): string[];
    };
}

    Mohamed Hegazy (@mhegazy) Thanks for the info! I'll take a look either later tonight or tomorrow and give it a shot 👍

  6. dsifford commented on Apr 26, 2018

    @dsifford
    Derek Sifford (dsifford)
    on Apr 26, 2018
    ContributorAuthor

    Mohamed Hegazy (@mhegazy) Looking at the example you linked to... I'm not sure how that file is even being included in the main lib.d.ts? I tried adding a slew of different configurations to my tsconfig (different targets, adding all of the es2017 libs, etc) and I still could not get formatToParts to ever show up.

    Is this confirmed to be working correctly? What am I doing wrong here? Any tips are greatly appreciated.

  7. mhegazy commented on Apr 26, 2018

    @mhegazy
    Mohamed Hegazy (mhegazy)
    on Apr 26, 2018
    Contributor

    The final file is built using a Jake/Gulp tasks. here is a link https://github.com/Microsoft/TypeScript/blob/master/Jakefile.js#L120

  8. dsifford commented on Apr 26, 2018

    @dsifford
    Derek Sifford (dsifford)
    on Apr 26, 2018
    ContributorAuthor

    Thanks for the info. That still only half-solves my question. Again, I've configured my tsconfig in every way imaginable and I still cannot get functionality from es2017.intl.d.ts to work right now in TypeScript (namely, the formatToParts method).

    So my worry is that if that's someway malformatted or configured incorrectly, basing my PR on that implementation will lead to a malformatted or misconfigured implementation of PluralRules.

  9. mhegazy commented on Apr 26, 2018

    @mhegazy
    Mohamed Hegazy (mhegazy)
    on Apr 26, 2018
    Contributor

    tsc --lib es2017,es2017.intl

  10. dsifford commented on Apr 26, 2018

    @dsifford
    Derek Sifford (dsifford)
    on Apr 26, 2018
    ContributorAuthor

    Mohamed Hegazy (@mhegazy) Did you try that?

    Here's the output for me (latest TypeScript version):

    dsifford ~/repos/test-intl
$ tsc --lib es2017,es2017.intl
foo.ts(3,3): error TS2339: Property 'formatToParts' does not exist on type 'DateTimeFormat'.

    From the schema currently listed at http://json.schemastore.org/tsconfig:

    "lib": {
    "description": "Specify library file to be included in the compilation. Requires TypeScript version 2.0 or later.",
    "type": "array",
    "items": {
        "type": "string",
        "enum": [
            "es5",
            "es6",
            "es2015",
            "es7",
            "es2016",
            "es2017",
            "es2018",
            "esnext",
            "dom",
            "dom.iterable",
            "webworker",
            "scripthost",
            "es2015.core",
            "es2015.collection",
            "es2015.generator",
            "es2015.iterable",
            "es2015.promise",
            "es2015.proxy",
            "es2015.reflect",
            "es2015.symbol",
            "es2015.symbol.wellknown",
            "es2016.array.include",
            "es2017.object",
            "es2017.sharedmemory",
            "es2017.string",
            "es2017.typedarrays",
            "es2018.promise",
            "es2018.regexp",
            "esnext.array",
            "esnext.asynciterable"
        ]
    }
},

    There is no mention of es2017.intl.

  11. mhegazy commented on Apr 26, 2018

    @mhegazy
    Mohamed Hegazy (mhegazy)
    on Apr 26, 2018
    Contributor
    c:\test\sandbox>type a.ts
declare var x: DateTimeFormatPartTypes;
declare var d: DateTimeFormat;
d.formatToParts();

c:\test\sandbox>tsc --v
Version 2.8.3

c:\test\sandbox>tsc --lib es2017,es2017.intl a.ts

c:\test\sandbox>tsc --lib es2017,es2017.intl a.ts --listFiles
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2017.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2017.typedarrays.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2017.intl.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2017.string.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2017.sharedmemory.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2017.object.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2016.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2016.array.include.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es5.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.symbol.wellknown.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.reflect.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.proxy.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.iterable.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.symbol.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.promise.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.generator.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.collection.d.ts
C:/Users/mhegazy/AppData/Roaming/npm/node_modules/typescript/lib/lib.es2015.core.d.ts
a.ts

  12. dsifford commented on Apr 27, 2018

    @dsifford
    Derek Sifford (dsifford)
    on Apr 27, 2018
    ContributorAuthor

    hmmmm... The plot thickens.

    Thanks for the info. That's extremely helpful. Let's put a pin in this for now. I'll try and sort out what's going on on my machine and get back to this tomorrow at some point.

    Thanks again for all your help. 🙏

  13. dsifford commented on Apr 29, 2018

    @dsifford
    Derek Sifford (dsifford)
    on Apr 29, 2018
    ContributorAuthor

    Alright Mohamed Hegazy (@mhegazy) so I investigated it further...

    I still think the formatToParts method is not typed properly because your example works only when you declare d as type DateTimeFormat. It does not work, however, when it is type Intl.DateTimeFormat.

    // works
declare var d: DateTimeFormat;
d.formatToParts();
    // does not work
declare var d: Intl.DateTimeFormat;
d.formatToParts(); // Property 'formatToParts' does not exist on type 'DateTimeFormat'.

    I think if formatToParts was typed similarly to how my implementation above, this issue will resolve.

    Can you confirm this?

    I tried in the playground, locally on my machine at home, and on codesandbox.com and all three locations I'm able to repro the issue.

    .... full stop ....

    With that in mind, what about just creating a lib.es2018.intl.d.ts file and literally dropping in the code snippet that I pasted in above? Would that work?

    Second. If my suspicion is correct, should I start a new thread for the formatToParts issue?

    Thanks for your patience. I greatly appreciate your hospitality.

  14. mhegazy commented on Apr 29, 2018

    @mhegazy
    Mohamed Hegazy (mhegazy)
    on Apr 29, 2018
    Contributor

    We need a new file, and we need it wired in the build like the lib.es217.intl.d.ts. And also in the commandline parser.

  15. mhegazy commented on Apr 29, 2018

    @mhegazy
    Mohamed Hegazy (mhegazy)
    on Apr 29, 2018
    Contributor

    I will need to check the spec for the formattoparts question and get back to you.

  16. dsifford commented on Apr 29, 2018

    @dsifford
    Derek Sifford (dsifford)
    on Apr 29, 2018
    ContributorAuthor

    Ok sounds great. I'll hold off until you're able to confirm.

  17. mhegazy commented on Apr 30, 2018

    @mhegazy
    Mohamed Hegazy (mhegazy)
    on Apr 30, 2018
    Contributor

    So the declarations in es2017.intl.d.ts are completely wrong. there is no global type DateTimeFormat, there is only Intl.DateTimeFormat. so this files needs fixing as well. we need to wrap the file in declare namespace Intl { ... } declaration. thanks for pointing this one out.

  18. dsifford commented on Apr 30, 2018

    @dsifford
    Derek Sifford (dsifford)
    on Apr 30, 2018
    ContributorAuthor

    Ok phew! Glad to hear I wasn't completely mistaken.

    I'd be happy to attempt to tackle both of these. Would you prefer them in the same PR or separate?

  19. mhegazy commented on Apr 30, 2018

    @mhegazy
    Mohamed Hegazy (mhegazy)
    on Apr 30, 2018
    Contributor

    either is fine. up to you.

  20. Mohamed Hegazy (mhegazy)
    closed this as completedin #23785on Apr 30, 2018
  21. Mohamed Hegazy (mhegazy)
    added a commit that references this issue on Apr 30, 2018

    add lib.es2018.intl + fix lib.es2017.intl

    cc0c82c
  22. Mohamed Hegazy (mhegazy)
    modified the milestones: , TypeScript 2.9 on Apr 30, 2018
  23. Mohamed Hegazy (mhegazy)
    added
    FixedA PR has been merged for this issue
    on Apr 30, 2018
  24. microsoft
    locked and limited conversation to collaborators on Jul 31, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    BugA bug in TypeScriptDomain: lib.d.tsThe issue relates to the different libraries shipped with TypeScriptFixedA PR has been merged for this issueHelp WantedYou can do this

    Type

    No type

    Projects

    No projects

      Milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions