1950401 - Figure out how to make TypeScript work with classes that implement idl interfaces with constants

Status: RESOLVED FIXED

(Developer Infrastructure :: Lint and Formatting, task, P3)

Description

[Mark Banner (:standard8)]

We have an nsIAutoCompleteResult interface, for which the definition starts off like:

interface nsIAutoCompleteResult : nsISupports
{
  const unsigned short RESULT_IGNORED = 1; /* indicates invalid searchString */
  const unsigned short RESULT_FAILURE = 2; /* indicates failure */
...

I have a class which implements it, so for TypeScript to understand this, I'm adding an annotation:

/**
  * @implements {nsIAutoCompleteResult}
  */
class SearchHistoryResult {
...

However, this fails with:

Type 'SearchHistoryResult' is missing the following properties from type 'nsIAutoCompleteResult': RESULT_IGNORED, RESULT_FAILURE, RESULT_NOMATCH, RESULT_SUCCESS, and 2 more.

:zombie suggested doing something like @implements {Omit<nsIAutoCompleteResult, "RESULT_IGNORED"|"RESULT_NOMATCH"|"RESULT_NOMATCH"|"RESULT_FAILURE"|"RESULT_SUCCESS"|"RESULT_NOMATCH_ONGOING"|"RESULT_SUCCESS_ONGOING">} however, that then runs into issues when we try to pass the class to a function that takes an nsIAutoCompleteResult:

Argument of type 'SearchHistoryResult' is not assignable to parameter of type 'nsIAutoCompleteResult'.
  Type 'SearchHistoryResult' is missing the following properties from type 'nsIAutoCompleteResult': RESULT_IGNORED, RESULT_FAILURE, RESULT_NOMATCH, RESULT_SUCCESS, and 2 more.

Comment 1

[Tomislav Jovanovic :zombie]

Attachment: Bug 1950401 - Mark constants (and enum variants) in xpcom interfaces as optional r?Standard8

Comment 2

[Pulsebot]

Pushed by [e-mail]:
https://hg.mozilla.org/integration/autoland/rev/61095d707c5b
Mark constants (and enum variants) in xpcom interfaces as optional r=Standard8

Comment 3

[Cristina Horotan [:chorotan]]

https://hg.mozilla.org/mozilla-central/rev/61095d707c5b