Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Fix wrong type for LocaleMatcher ('best-fit' to 'best fit'). #1118

Merged
merged 1 commit into from Feb 16, 2021

Conversation

mpawelski
Copy link
Contributor

Hi everyone!
I was testing if my project compiles with TS 4.2 RC. and it didn't because of wrong typing of vue-i18n :(
This fixes it.
Hope this is a good PR.

from commit message:

In Typescript 4.2 type definitions for Intl API was updated (microsoft/TypeScript#41880).
Because of that we now have compile error when we try to compile vue-i18n in TS 4.2 RC.
The reason is our wrong type definition for "localeMatcher" and "formatMatcher" properties.
We had "best-fit" but it should be "best fit".

This was the error when we compile vue-i18n with Typescript 4.2 RC. Now it's fixed.:

> npx typescript@4.2.1-rc -p types
npx: installed 1 in 3.512s
types/index.d.ts:26:13 - error TS2430: Interface 'SpecificDateTimeFormatOptions' incorrectly extends interface 'DateTimeFormatOptions'.
Types of property 'localeMatcher' are incompatible.
    Type 'LocaleMatcher | undefined' is not assignable to type '"best fit" | "lookup" | undefined'.
    Type '"best-fit"' is not assignable to type '"best fit" | "lookup" | undefined'.

26   interface SpecificDateTimeFormatOptions extends Intl.DateTimeFormatOptions {
            ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Found 1 error.

In Typescript 4.2 type definitions for Intl API was updated (microsoft/TypeScript#41880).
Because of that we now have compile error when we try to compile vue-i18n in TS 4.2 RC.
The reason is our wrong type definition for "localeMatcher" and "formatMatcher" properties.
We had "best-fit" but it should be "best fit".

This was the error when we compile vue-i18n with Typescript 4.2 RC. Now it's fixed.:

    > npx typescript@4.2.1-rc -p types
    npx: installed 1 in 3.512s
    types/index.d.ts:26:13 - error TS2430: Interface 'SpecificDateTimeFormatOptions' incorrectly extends interface 'DateTimeFormatOptions'.
    Types of property 'localeMatcher' are incompatible.
        Type 'LocaleMatcher | undefined' is not assignable to type '"best fit" | "lookup" | undefined'.
        Type '"best-fit"' is not assignable to type '"best fit" | "lookup" | undefined'.

    26   interface SpecificDateTimeFormatOptions extends Intl.DateTimeFormatOptions {
                ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

    Found 1 error.
@kazupon kazupon added the Type: Improvement Includes backwards-compatible fixes label Feb 16, 2021
@simllll
Copy link

simllll commented Feb 24, 2021

@kazupon typescript 4.2 got released yesterday night, can you release a new version to cover this fix? :) thanks a lot

@kazupon
Copy link
Owner

kazupon commented Feb 24, 2021

I've just released v8.23.0!
Please check it out!
https://github.com/kazupon/vue-i18n/releases/tag/v8.23.0

This was referenced Mar 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
PR: merged Type: Improvement Includes backwards-compatible fixes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants