GV

GeezerVison

The World Wide Web, restored to 800 pixels of glory.

Home|About|Gaming cabinet|Archives|How it works|Starter sites

On this site

  • Sign in
  • ActionsCI/CD and automation
  • CodespacesCloud development environments
  • All Features
  • Documentation
  • Training
  • Certifications
  • Build with Copilot
  • Customize Copilot
  • Integrations
  • Trending repos
  • GitHub Sponsors
  • Developer articles
  • Enterprises

This view

  • Original page
  • New address

GeezerVison is showing github.com — Properties with index signatures formatted incorrectly · Issue #2917 · TypeStrong/typedoc

Properties with index signatures formatted incorrectly #2917

New issue
Copy link
New issue
Copy link
Closed
Bug
Closed
Properties with index signatures formatted incorrectly#2917
Bug
Copy link
Milestone
v0.28.2

Description

@Blackbaud-SteveBrush
Blackbaud-SteveBrush
opened on Mar 24, 2025
Issue body actions

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

Activity

  1. Blackbaud-SteveBrush
    added the
    Bug
    issue type on Mar 24, 2025
  2. Gerrit0
    closed this as completedin 79a3310on Mar 28, 2025
  3. Gerrit0
    added this to the v0.28.2 milestone on Mar 28, 2025
  4. pull
    added a commit that references this issue on Mar 29, 2025

    Fix TypeStrong#2917

    This issue will close once commit 79a3310 is merged into the 'master' branch.
    79a3310
  5. Blackbaud-SteveBrush commented on Apr 1, 2025

    @Blackbaud-SteveBrush
    Blackbaud-SteveBrush
    on Apr 1, 2025
    Author
    More actions

    Thank you!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    Bug

    Projects

    No projects

      Milestone

      • v0.28.2

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions

      You are visitor 01402520 — GeezerVison does not store the pages you look up.
      Best viewed with Netscape Navigator 4.7 or Internet Explorer 6 at 800×600. No cookies required.