Skip to content

Complete structured metadata in the canonical TypeScript API export #20266

Description

Is there an existing issue for this?

  • I have searched the existing issues.

Part of #20258. No prerequisite sibling issue. #19032 is merged groundwork; options-name policy remains in #19141.

Is your feature request related to a problem? Please describe the problem.

Existing ATS/resolved-model data is omitted from canonical TypeScript JSON: return prose, entry-function parameters, defaults, callback/accessor details, nested remarks, and ownership. Shared options can discard usage-specific documentation.

Describe the solution you'd like

  • Expose existing signature, documentation, status, value, ownership, and relationship data as structured metadata on currently supported symbol kinds.
  • Preserve per-capability parameter docs/defaults when options types are shared.
  • Keep declarations and metadata on the same resolved model; add compatible schema fields without changing generated signatures.
  • Verify direct ATS-model fixtures and serialized output, including sparse/older payloads and shared options.

Independent delivery: Use current capture data and symbol kinds; tests need neither scanner fixes nor new helpers from #20268. Do not add raw-dump changes, new documentation sections, or previously absent public symbols. #20263/#20264 own any new fields they introduce; #20268 owns symbol inventory. A later merge should require integration/rebasing, not completion of another issue.

Additional context

Canonical model. Compiled probes confirm missing metadata and shared-options loss. Consumer adoption is separate.

Activity

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

    No type

    Projects

    No projects

      Milestone

      No milestone

      Relationships

      None yet

      Development

      No branches or pull requests

      Issue actions