Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Properties with index signatures formatted incorrectly #2917

Closed
Blackbaud-SteveBrush opened this issue Mar 24, 2025 · 0 comments
Closed

Properties with index signatures formatted incorrectly #2917

Blackbaud-SteveBrush opened this issue Mar 24, 2025 · 0 comments
Milestone

Comments

@Blackbaud-SteveBrush
Copy link

Search terms

index signatures, formatting

Expected Behavior

First of all, I just wanted to say "Thank You" for this awesome utility; our team uses the JavaScript API to document over 75 TypeScript libraries.

Given the following interface...

export interface Foo {
  data: {
    [key: string]: any;
  }
}

I would expect the data property's index signature toString() method to output [key: string]: any;.

Actual Behavior

TypeDoc 0.28.1 outputs (key: string) => any;, without the square brakets.

Steps to reproduce the bug

Clone the following (minimal) repo: https://github.com/Blackbaud-SteveBrush/typedoc-playground

Run npm install && node ./run-typedoc.mjs and observe the output.

TypeDoc: 0.28.0-beta.2
TypeScript: 5.7.3
OS: Mac, Sequoia

@Gerrit0 Gerrit0 added this to the v0.28.2 milestone Mar 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants