Symbol properties rendered as strings

[dgreensp]

Search terms

Symbol property, computed property name, string

Expected Behavior

Render computed properties in some way that looks like TypeScript syntax.

Actual Behavior

Renders computed properties as string literals in signatures, both at the type level and member level:

interface Arrayish<T> {
    "[iterator]"(): IterableIterator<T>;
    length: number;
    slice: (start?: number, end?: number) => Arrayish<T>;
    readonly [index: number]: T;
}

Steps to reproduce the bug

Run TypeDoc on this code:

export interface Arrayish<T> {
  readonly [index: number]: T;
  readonly length: number;
  [Symbol.iterator](): IterableIterator<T>;
  slice: (start?: number, end?: number) => Arrayish<T>;
}

Environment

• Typedoc version: 0.28.13
• TypeScript version: 5.9.2
• Node.js version: v22.18.0
• OS: macOS 14.6.1

[Gerrit0]

Fixing this is going to result in a breaking change as to do so typedoc needs to have member names not just be strings, but potentially a computed expression... going to have to wait for 0.29 for that reason.

[dgreensp]

Sounds good!

Part of me says, I just want it to print the string it already has, but not wrap it in quotes. It would just have to know that the property is not in fact the string "[iterator]" (as a property name could start with a square bracket, as unusual as that would be).