TypeStrong / TypeStrong/typedoc
Symbol properties rendered as strings
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 8.5k
- Forks
- 775
- PR merge metrics
- No merged PRs in 30d
Description
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
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start by running TypeDoc 0.28.13 on the reproduced Arrayish interface with TypeScript 5.9.2 and inspect how its generated signature renders the computed Symbol.iterator property. Done means computed properties no longer appear as quoted string literals and instead resemble valid TypeScript syntax at both type and member levels.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 52/100