We read every piece of feedback, and take your input very seriously.
To see all available qualifiers, see our documentation.
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
index signatures, formatting
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;.
data
toString()
[key: string]: any;
TypeDoc 0.28.1 outputs (key: string) => any;, without the square brakets.
(key: string) => any;
Clone the following (minimal) repo: https://github.com/Blackbaud-SteveBrush/typedoc-playground
Run npm install && node ./run-typedoc.mjs and observe the output.
npm install && node ./run-typedoc.mjs
TypeDoc: 0.28.0-beta.2 TypeScript: 5.7.3 OS: Mac, Sequoia
The text was updated successfully, but these errors were encountered:
79a3310
No branches or pull requests
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...
I would expect the
data
property's index signaturetoString()
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
The text was updated successfully, but these errors were encountered: