Intellisense for Symbol properties

Suggestion

🔍 Search Terms

With and without "is:issue is:open"
"symbol intellisense"
"symbol autocomplete"

✅ Viability Checklist

My suggestion meets these guidelines:

• This wouldn't be a breaking change in existing TypeScript/JavaScript code
• This wouldn't change the runtime behavior of existing JavaScript code
• This could be implemented without emitting different JS based on the types of the expressions
• This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, new syntax sugar for JS, etc.)
• This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

Intellisense provides a list of symbol properties which, when accepted, insert indexed accessor syntax for that symbol. This list would be comprised of known symbols within the current scope or those that can be with an import statement.

📃 Motivating Example

This example demonstrates a type that implements the global Disposable interface introduced by TC39 ECMAScript Explicit Resource Management. (#54505)

class ExampleClass implements Disposable {
  [Symbol.dispose](): void {
    // ...
  }
}

const example = new ExampleClass();

example[Symbol.dispose]();

The suggestions shown for example. do not includeSymbol.dispose.

💻 Use Cases

TL;DR: Symbol.dispose and Symbol.asyncDispose are the first well-known symbols that are useful to call directly, and I want to easily know that they're there.

Typically, ES6 Symbols are intended as an implementation detail, but the new global Disposable interface, however, is analogous to this very prolific interface:

interface Disposable {
  dispose(): void;
}

In order to support using syntax, I need to implement the global Disposable interface. I have a few options:

• Switch to the global Disposable interface, but lose the visibility to developers of the lifecycle management requirements of implementations.
• Make my Disposable interface extend the global Disposable interface, or possibly merge it with the global one and then, by convention, do the following:

dispose(): void {
  // ...
}

[Symbol.dispose](): void {
  this.dispose();
}

An option is to create a utility class decorator that does that for me, but unfortunately that creates the issue of how to make that class recognized as an implementation of the global Disposable. (#4881)

Das Issue nennt keine Dateien, Tests oder Einstiegspunkte. Beginne damit, den example.-Vervollständigungsfall aus dem motivierenden Beispiel zu reproduzieren, und vergleiche ihn mit den gewünschten Vorschlägen Symbol.dispose und Symbol.asyncDispose. Als erledigt gilt die Aufgabe, wenn die relevanten Symboleigenschaften in IntelliSense erscheinen und das bestehende Vervollständigungsverhalten erhalten bleibt.