microsoft / microsoft/TypeScript
Intl.Collator#compare method type does not match spec
- Dominant language
- Go
- Stars
- 111k
- Forks
- 14.3k
- PR merge metrics
- PR metrics pending
Description
### ⚙ Compilation target
ES2022
### ⚙ Library
N/A
### Missing / Incorrect Definition
The [Intl.Collator](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator) object has a `compare` method which is declared as `compare(x: string, y: string): number;` but according to [the relevant spec](https://tc39.es/ecma402/#sec-intl.collator.prototype.compare) is actually `get compare(): (this: void, x: string, y: string) => number`. Importantly, the spec states that
> The returned function is bound to `collator` so that it can be passed directly to `Array.prototype.sort` or other functions
### Sample Code
I'm having trouble putting together a Playground example that cares about the difference (which is admittedly subtle!) but it's the cause of https://github.com/typescript-eslint/typescript-eslint/issues/7098
### Documentation Link
[Collator#compare spec](https://tc39.es/ecma402/#sec-intl.collator.prototype.compare)
[MDN docs on compare method](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/Collator/compare#using_compare_for_array_sort)
Contributor guide
Assessment
This issue has not been assessed yet.