types.ts

Extended base class — 0 or 1 entries (TypeScript allows only one base). An array so every heritage field (extends, implements, externalTypes, InterfaceDeclarationJson.extends) shares one shape; consumers iterate heritage uniformly instead of branching on kind.

Verbatim text of this declaration's own heritage clause (as is implements), so it is spelled as this module wrote it and resolves in its scope — a local rename stays the local name, where externalTypes resolves renames because its walk crosses modules.

External types the extends chain reaches whose contributions members never enumerates — the class counterpart of InterfaceDeclarationJson.externalTypes, descending through local base classes. implements contributes nothing: an implemented interface adds no members, the class declares its own.

Entry normalization (rename resolution, type-parameter substitution, text-dedupe, source order) matches TypeDeclarationJson.externalTypes.

Implemented interfaces.

Class members: methods, properties, constructors, getters/setters — own members only, inherited members excluded whatever their origin.

Module paths (relative to sourceRoot) that re-export this declaration under the same name. The canonical declaration lives in this module's declarations array; these paths are additional import locations for the same thing.

The same edges appear from the re-exporting side as ModuleJson.reExports — use that when asking "what does this module re-export" instead of inverting these arrays. The two can disagree at the margins: a reExports entry whose canonical declaration is @nodocs (or whose module isn't in the analyzed set) has no back-link here.

Consumer note: To build a complete re-export map, scan two fields:

1. alsoExportedFrom on each declaration — same-name re-exports
2. aliasOf on declarations — renamed re-exports (separate declarations)

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

The exported name. Always populated. The default-export slot is named 'default' — that's the symbol's actual name in JS (import {default as X} and ns.default both expose it directly), and import X from 'mod' is sugar for import {default as X}. Consumers branch on name === 'default' to render the sugar form when desired.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

For renamed re-exports (export {foo as bar}), points to the original declaration. This declaration's name is the alias; aliasOf.name is the original name.

For renames out of the default slot (export {default as bar} from './x' where ./x is export default ...), aliasOf.name is 'default' — the canonical's actual symbol name. Consumers locate the canonical by (aliasOf.module, aliasOf.name).

Svelte component exception: when the source is a .svelte file (e.g., export {default as Foo} from './X.svelte'), the canonical's name is the component name (derived from the filename), so aliasOf.name is the component name ('X'), NOT 'default'. Consumers that branch on aliasOf.name === 'default' to detect default-rename should additionally check whether aliasOf.module ends with .svelte.

Different from alsoExportedFrom: aliases create new API surface names, while alsoExportedFrom tracks additional import paths for the same name.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).

External types whose properties are filtered out of props — the attribute bags a component forwards, such as HTMLButtonAttributes or SvelteHTMLElements['button'].

Covers every way props compose them: an intersection or union branch, a bare or indexed-access annotation, and interface Props extends Bag (directly or through a local base). Entries carry the written form with the same normalizations as TypeDeclarationJson.externalTypes: import renames at the definition site resolve to the exported name, and a type parameter bound inside the descent substitutes its written argument — interface A<T> extends HTMLAttributes<T> reached via `Props extends A<HTMLDivElement> records HTMLAttributes<HTMLDivElement>`. The component's *own* generics stay in scope and emit as written (HTMLAttributes<T> beside the genericParams documenting T). Each distinct bag appears once, in source order; a local name is used only when it hides a definition the walk cannot traverse (a mapped or conditional type). Names carry no module, so two distinct bags sharing an exported name collapse to one entry.

Svelte component props.

Whether the component accepts children (explicit children prop, inherited, or implicit template usage).

Module paths (relative to sourceRoot) that re-export this declaration under the same name. The canonical declaration lives in this module's declarations array; these paths are additional import locations for the same thing.

The same edges appear from the re-exporting side as ModuleJson.reExports — use that when asking "what does this module re-export" instead of inverting these arrays. The two can disagree at the margins: a reExports entry whose canonical declaration is @nodocs (or whose module isn't in the analyzed set) has no back-link here.

Consumer note: To build a complete re-export map, scan two fields:

1. alsoExportedFrom on each declaration — same-name re-exports
2. aliasOf on declarations — renamed re-exports (separate declarations)

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

The exported name. Always populated. The default-export slot is named 'default' — that's the symbol's actual name in JS (import {default as X} and ns.default both expose it directly), and import X from 'mod' is sugar for import {default as X}. Consumers branch on name === 'default' to render the sugar form when desired.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

Script language. undefined means TypeScript (default), 'js' for JavaScript-only components.

For renamed re-exports (export {foo as bar}), points to the original declaration. This declaration's name is the alias; aliasOf.name is the original name.

For renames out of the default slot (export {default as bar} from './x' where ./x is export default ...), aliasOf.name is 'default' — the canonical's actual symbol name. Consumers locate the canonical by (aliasOf.module, aliasOf.name).

Svelte component exception: when the source is a .svelte file (e.g., export {default as Foo} from './X.svelte'), the canonical's name is the component name (derived from the filename), so aliasOf.name is the component name ('X'), NOT 'default'. Consumers that branch on aliasOf.name === 'default' to detect default-rename should additionally check whether aliasOf.module ends with .svelte.

Different from alsoExportedFrom: aliases create new API surface names, while alsoExportedFrom tracks additional import paths for the same name.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

Prop name as declared in the component's $props() type.

Resolved TypeScript type string.

Whether the prop is optional in the component's props type.

Whether the prop uses the $bindable() rune, enabling two-way binding.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

Structured type; absent when type is the whole story (see TypeJson).

Description from JSDoc on the prop's type declaration.

Default value expression from destructuring or @default tag.

Structured parameters for callable props (e.g., Snippet<[text: string]>).

Present when the prop has extractable parameters, absent otherwise. Only populated when there are actual parameters — bare Snippet / Snippet<[]> does not set this field. Intentionally .optional() rather than .default([]) (see the array-field policy note above): absence is a meaningful signal, not an empty list.

Prop name as declared in the component's $props() type.

Resolved TypeScript type string.

Code examples from @example tags.

Deprecation message from @deprecated tag.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

Version introduced, from @since tag.

Structured type; absent when type is the whole story (see TypeJson).

Whether the prop is optional in the component's props type.

Description from JSDoc on the prop's type declaration.

Default value expression from destructuring or @default tag.

Whether the prop uses the $bindable() rune, enabling two-way binding.

Structured parameters for callable props (e.g., Snippet<[text: string]>).

Present when the prop has extractable parameters, absent otherwise. Only populated when there are actual parameters — bare Snippet / Snippet<[]> does not set this field. Intentionally .optional() rather than .default([]) (see the array-field policy note above): absence is a meaningful signal, not an empty list.

Function/method/constructor parameters.

Overload signatures (when there are multiple public overloads). Includes all public overloads. The implementation signature is excluded. Empty when there are no overloads (single signature).

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).

Enum members: name/value pairs with optional JSDoc.

Module paths (relative to sourceRoot) that re-export this declaration under the same name. The canonical declaration lives in this module's declarations array; these paths are additional import locations for the same thing.

The same edges appear from the re-exporting side as ModuleJson.reExports — use that when asking "what does this module re-export" instead of inverting these arrays. The two can disagree at the margins: a reExports entry whose canonical declaration is @nodocs (or whose module isn't in the analyzed set) has no back-link here.

Consumer note: To build a complete re-export map, scan two fields:

1. alsoExportedFrom on each declaration — same-name re-exports
2. aliasOf on declarations — renamed re-exports (separate declarations)

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

The exported name. Always populated. The default-export slot is named 'default' — that's the symbol's actual name in JS (import {default as X} and ns.default both expose it directly), and import X from 'mod' is sugar for import {default as X}. Consumers branch on name === 'default' to render the sugar form when desired.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

For renamed re-exports (export {foo as bar}), points to the original declaration. This declaration's name is the alias; aliasOf.name is the original name.

For renames out of the default slot (export {default as bar} from './x' where ./x is export default ...), aliasOf.name is 'default' — the canonical's actual symbol name. Consumers locate the canonical by (aliasOf.module, aliasOf.name).

Svelte component exception: when the source is a .svelte file (e.g., export {default as Foo} from './X.svelte'), the canonical's name is the component name (derived from the filename), so aliasOf.name is the component name ('X'), NOT 'default'. Consumers that branch on aliasOf.name === 'default' to detect default-rename should additionally check whether aliasOf.module ends with .svelte.

Different from alsoExportedFrom: aliases create new API surface names, while alsoExportedFrom tracks additional import paths for the same name.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).

Public exported name from this module.

Module specifier as written in the statement (e.g. 'pkg').

Whether the statement or specifier is type-only — see ReExportJson.typeOnly.

The name inside the external module when renamed (export {x as y} from 'pkg' → 'x'). Omitted for same-name re-exports and namespace form (export * as ns).

1-based line of the export specifier in this module's source.

Public exported name from this module.

Module specifier as written in the statement (e.g. 'pkg').

The name inside the external module when renamed (export {x as y} from 'pkg' → 'x'). Omitted for same-name re-exports and namespace form (export * as ns).

Whether the statement or specifier is type-only — see ReExportJson.typeOnly.

1-based line of the export specifier in this module's source.

Function/method/constructor parameters.

Overload signatures (when there are multiple public overloads). Includes all public overloads. The implementation signature is excluded. Empty when there are no overloads (single signature).

Module paths (relative to sourceRoot) that re-export this declaration under the same name. The canonical declaration lives in this module's declarations array; these paths are additional import locations for the same thing.

The same edges appear from the re-exporting side as ModuleJson.reExports — use that when asking "what does this module re-export" instead of inverting these arrays. The two can disagree at the margins: a reExports entry whose canonical declaration is @nodocs (or whose module isn't in the analyzed set) has no back-link here.

Consumer note: To build a complete re-export map, scan two fields:

1. alsoExportedFrom on each declaration — same-name re-exports
2. aliasOf on declarations — renamed re-exports (separate declarations)

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

The exported name. Always populated. The default-export slot is named 'default' — that's the symbol's actual name in JS (import {default as X} and ns.default both expose it directly), and import X from 'mod' is sugar for import {default as X}. Consumers branch on name === 'default' to render the sugar form when desired.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

Function/method return type.

Structured return type; absent when returnType is the whole story (see TypeJson).

Return value description from @returns tag.

For renamed re-exports (export {foo as bar}), points to the original declaration. This declaration's name is the alias; aliasOf.name is the original name.

For renames out of the default slot (export {default as bar} from './x' where ./x is export default ...), aliasOf.name is 'default' — the canonical's actual symbol name. Consumers locate the canonical by (aliasOf.module, aliasOf.name).

Svelte component exception: when the source is a .svelte file (e.g., export {default as Foo} from './X.svelte'), the canonical's name is the component name (derived from the filename), so aliasOf.name is the component name ('X'), NOT 'default'. Consumers that branch on aliasOf.name === 'default' to detect default-rename should additionally check whether aliasOf.module ends with .svelte.

Different from alsoExportedFrom: aliases create new API surface names, while alsoExportedFrom tracks additional import paths for the same name.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).

User-chosen identifier, or the literal '(call)' sentinel for unnamed call signatures.

Whether the member has a ? token in its declaration.

Function/method/constructor parameters.

Overload signatures (when there are multiple public overloads). Includes all public overloads. The implementation signature is excluded. Empty when there are no overloads (single signature).

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

Default value documented via @default — for a callable member, typically the behavior used when the callback is omitted. Always tag-authored (structural containers have no initializers). Members only: top-level function declarations and overloads never carry one.

Function/method return type.

Structured return type; absent when returnType is the whole story (see TypeJson).

Return value description from @returns tag.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).

Parameter name like T.

Constraint like string from T extends string.

Default type like unknown from T = unknown.

Extended interfaces.

Verbatim text of this declaration's own heritage clause, so entries are spelled as this module wrote them and resolve in its scope — a local rename (import type {Bag as B}) stays B. Unlike externalTypes, whose walk crosses modules and therefore resolves renames back to the exported name, this clause never leaves the declaring file.

External types the heritage composition reaches whose contributions members never enumerates.

Interface members are own-only, so nothing is *filtered* — inherited content simply isn't listed. This field names the external types behind that absence: interface Props extends HTMLButtonAttributes records the bag directly, and interface Props extends LocalBase (where LocalBase reaches a bag) records it transitively — the same answer the component annotated with this interface gets, where extends alone dead-ends at a possibly-unexported local name. Inherited *local* content is the extends field's business: the base is documented at its own declaration.

Entry normalization (rename resolution, type-parameter substitution, text-dedupe, source order) matches TypeDeclarationJson.externalTypes.

Interface members: property signatures, method signatures, index signatures, call/construct signatures — own members only, inherited members excluded whatever their origin (call/construct signatures included: a base interface's (call) is not enumerated here).

The exported name also carries a value meaning — a merged value+type symbol (const Foo = ... + interface Foo {...}), where the interface wins the declaration slot and the value's own type goes undocumented. Tells consumers the name is importable as a runtime value: `import {Foo}, never import type {Foo} (see generateImport`).

Module paths (relative to sourceRoot) that re-export this declaration under the same name. The canonical declaration lives in this module's declarations array; these paths are additional import locations for the same thing.

The same edges appear from the re-exporting side as ModuleJson.reExports — use that when asking "what does this module re-export" instead of inverting these arrays. The two can disagree at the margins: a reExports entry whose canonical declaration is @nodocs (or whose module isn't in the analyzed set) has no back-link here.

Consumer note: To build a complete re-export map, scan two fields:

1. alsoExportedFrom on each declaration — same-name re-exports
2. aliasOf on declarations — renamed re-exports (separate declarations)

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

The exported name. Always populated. The default-export slot is named 'default' — that's the symbol's actual name in JS (import {default as X} and ns.default both expose it directly), and import X from 'mod' is sugar for import {default as X}. Consumers branch on name === 'default' to render the sugar form when desired.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

For renamed re-exports (export {foo as bar}), points to the original declaration. This declaration's name is the alias; aliasOf.name is the original name.

For renames out of the default slot (export {default as bar} from './x' where ./x is export default ...), aliasOf.name is 'default' — the canonical's actual symbol name. Consumers locate the canonical by (aliasOf.module, aliasOf.name).

Svelte component exception: when the source is a .svelte file (e.g., export {default as Foo} from './X.svelte'), the canonical's name is the component name (derived from the filename), so aliasOf.name is the component name ('X'), NOT 'default'. Consumers that branch on aliasOf.name === 'default' to detect default-rename should additionally check whether aliasOf.module ends with .svelte.

Different from alsoExportedFrom: aliases create new API surface names, while alsoExportedFrom tracks additional import paths for the same name.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).

Path relative to sourceRoot (e.g., helpers.ts for the default SvelteKit src/lib layout). sourceRoot is configurable via createSourceOptions / the CLI --source-root flag — consumers with a custom layout (e.g., sourcePaths: ['src/lib', 'src/routes'], sourceRoot: 'src') see prefixes like lib/foo.ts here.

Exported declarations from this module.

Modules this imports (paths relative to sourceRoot).

Modules that import this (paths relative to sourceRoot).

Modules fully re-exported via export * from './module'. Paths are relative to sourceRoot. Statement-level @nodocs suppresses the entry, like the other re-export encodings.

Same-name re-exports in this module's source, sorted by name then module (names can collide — see ReExportJson). The forward view of alsoExportedFrom — see ReExportJson for the full contract (canonical resolution, Svelte default-slot naming, @nodocs suppression, presence caveats).

Re-exports whose immediate target is an external package, sorted by name then specifier. See ExternalReExportJson for which forms are captured.

External modules fully re-exported via export * from 'pkg', as written (statement order). The projected names are unknown — the package isn't analyzed. Statement-level @nodocs suppresses the entry; unresolvable specifiers are skipped.

Whether the module is a placeholder for a file that couldn't be analyzed.

Currently only set for Svelte files where svelte2tsx threw at ingest (the transform_failed diagnostic carries the error). Placeholder modules have declarations: [] and serve as a structural slot so the modules array reflects the full owned set; consumers render them as "broken" entries.

File-level JSDoc comment (from @module tag).

Path relative to sourceRoot (e.g., helpers.ts for the default SvelteKit src/lib layout). sourceRoot is configurable via createSourceOptions / the CLI --source-root flag — consumers with a custom layout (e.g., sourcePaths: ['src/lib', 'src/routes'], sourceRoot: 'src') see prefixes like lib/foo.ts here.

Exported declarations from this module.

File-level JSDoc comment (from @module tag).

Modules this imports (paths relative to sourceRoot).

Modules that import this (paths relative to sourceRoot).

Modules fully re-exported via export * from './module'. Paths are relative to sourceRoot. Statement-level @nodocs suppresses the entry, like the other re-export encodings.

Same-name re-exports in this module's source, sorted by name then module (names can collide — see ReExportJson). The forward view of alsoExportedFrom — see ReExportJson for the full contract (canonical resolution, Svelte default-slot naming, @nodocs suppression, presence caveats).

Re-exports whose immediate target is an external package, sorted by name then specifier. See ExternalReExportJson for which forms are captured.

External modules fully re-exported via export * from 'pkg', as written (statement order). The projected names are unknown — the package isn't analyzed. Statement-level @nodocs suppresses the entry; unresolvable specifiers are skipped.

Whether the module is a placeholder for a file that couldn't be analyzed.

Currently only set for Svelte files where svelte2tsx threw at ingest (the transform_failed diagnostic carries the error). Placeholder modules have declarations: [] and serve as a structural slot so the modules array reflects the full owned set; consumers render them as "broken" entries.

Source module path (relative to sourceRoot) projected under this binding.

Module paths (relative to sourceRoot) that re-export this declaration under the same name. The canonical declaration lives in this module's declarations array; these paths are additional import locations for the same thing.

The same edges appear from the re-exporting side as ModuleJson.reExports — use that when asking "what does this module re-export" instead of inverting these arrays. The two can disagree at the margins: a reExports entry whose canonical declaration is @nodocs (or whose module isn't in the analyzed set) has no back-link here.

Consumer note: To build a complete re-export map, scan two fields:

1. alsoExportedFrom on each declaration — same-name re-exports
2. aliasOf on declarations — renamed re-exports (separate declarations)

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

The exported name. Always populated. The default-export slot is named 'default' — that's the symbol's actual name in JS (import {default as X} and ns.default both expose it directly), and import X from 'mod' is sugar for import {default as X}. Consumers branch on name === 'default' to render the sugar form when desired.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

For renamed re-exports (export {foo as bar}), points to the original declaration. This declaration's name is the alias; aliasOf.name is the original name.

For renames out of the default slot (export {default as bar} from './x' where ./x is export default ...), aliasOf.name is 'default' — the canonical's actual symbol name. Consumers locate the canonical by (aliasOf.module, aliasOf.name).

Svelte component exception: when the source is a .svelte file (e.g., export {default as Foo} from './X.svelte'), the canonical's name is the component name (derived from the filename), so aliasOf.name is the component name ('X'), NOT 'default'. Consumers that branch on aliasOf.name === 'default' to detect default-rename should additionally check whether aliasOf.module ends with .svelte.

Different from alsoExportedFrom: aliases create new API surface names, while alsoExportedFrom tracks additional import paths for the same name.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).

Full TypeScript type signature for this overload.

Parameters for this overload.

Generic type parameters for this overload.

Return type for this overload.

Structured return type; absent when returnType is the whole story (see TypeJson).

JSDoc/TSDoc comment specific to this overload.

Return value description from @returns tag on this overload.

Full TypeScript type signature for this overload.

Parameters for this overload.

Return type for this overload.

Structured return type; absent when returnType is the whole story (see TypeJson).

Generic type parameters for this overload.

JSDoc/TSDoc comment specific to this overload.

Return value description from @returns tag on this overload.

Parameter name (e.g., options, ...args).

Resolved TypeScript type string (e.g., string, Record<string, unknown>).

Whether the parameter has a ? token.

Whether the parameter uses rest syntax (...args).

Structured type; absent when type is the whole story (see TypeJson).

Description from @param tag.

Default value expression from the source (e.g., 'hello', 42).

Descriptions for properties of a named object parameter, from dotted @param tags (@param obj.prop - ...).

Keyed by the sub-path relative to this parameter — @param obj.prop becomes {prop: '...'}, @param obj.a.b becomes {'a.b': '...'}. Keys are unvalidated against the parameter's actual type (matching the @mutates philosophy); absent when no dotted @param tags reference this parameter. Only populated for function/method/constructor signature parameters.

Matching is by the parameter's name, so destructured parameters (fn({a, b}: T)) are not covered — TypeScript names them __0, with no author-facing identifier for a @param key to reference.

Parameter name (e.g., options, ...args).

Resolved TypeScript type string (e.g., string, Record<string, unknown>).

Structured type; absent when type is the whole story (see TypeJson).

Whether the parameter has a ? token.

Whether the parameter uses rest syntax (...args).

Description from @param tag.

Default value expression from the source (e.g., 'hello', 42).

Descriptions for properties of a named object parameter, from dotted @param tags (@param obj.prop - ...).

Keyed by the sub-path relative to this parameter — @param obj.prop becomes {prop: '...'}, @param obj.a.b becomes {'a.b': '...'}. Keys are unvalidated against the parameter's actual type (matching the @mutates philosophy); absent when no dotted @param tags reference this parameter. Only populated for function/method/constructor signature parameters.

Matching is by the parameter's name, so destructured parameters (fn({a, b}: T)) are not covered — TypeScript names them __0, with no author-facing identifier for a @param key to reference.

Exported name — the canonical declaration's name in module.

Module path (relative to sourceRoot) where the canonical declaration lives.

Whether the statement (export type {A} from ...) or specifier (export {type A} from ...) is type-only — the name is erased at runtime and importable only via import type.

1-based line of the export specifier in this module's source. When identical (name, module) edges are deduped (Svelte default-slot re-keying), the smallest line is kept.

Exported name — the canonical declaration's name in module.

Module path (relative to sourceRoot) where the canonical declaration lives.

Whether the statement (export type {A} from ...) or specifier (export {type A} from ...) is type-only — the name is erased at runtime and importable only via import type.

1-based line of the export specifier in this module's source. When identical (name, module) edges are deduped (Svelte default-slot re-keying), the smallest line is kept.

Snippet parameters.

Module paths (relative to sourceRoot) that re-export this declaration under the same name. The canonical declaration lives in this module's declarations array; these paths are additional import locations for the same thing.

The same edges appear from the re-exporting side as ModuleJson.reExports — use that when asking "what does this module re-export" instead of inverting these arrays. The two can disagree at the margins: a reExports entry whose canonical declaration is @nodocs (or whose module isn't in the analyzed set) has no back-link here.

Consumer note: To build a complete re-export map, scan two fields:

1. alsoExportedFrom on each declaration — same-name re-exports
2. aliasOf on declarations — renamed re-exports (separate declarations)

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

The exported name. Always populated. The default-export slot is named 'default' — that's the symbol's actual name in JS (import {default as X} and ns.default both expose it directly), and import X from 'mod' is sugar for import {default as X}. Consumers branch on name === 'default' to render the sugar form when desired.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

For renamed re-exports (export {foo as bar}), points to the original declaration. This declaration's name is the alias; aliasOf.name is the original name.

For renames out of the default slot (export {default as bar} from './x' where ./x is export default ...), aliasOf.name is 'default' — the canonical's actual symbol name. Consumers locate the canonical by (aliasOf.module, aliasOf.name).

Svelte component exception: when the source is a .svelte file (e.g., export {default as Foo} from './X.svelte'), the canonical's name is the component name (derived from the filename), so aliasOf.name is the component name ('X'), NOT 'default'. Consumers that branch on aliasOf.name === 'default' to detect default-rename should additionally check whether aliasOf.module ends with .svelte.

Different from alsoExportedFrom: aliases create new API surface names, while alsoExportedFrom tracks additional import paths for the same name.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).

The written label of a named tuple member ([a: string]).

The element's type. An optional element's type has the widening undefined stripped so optional carries it alone; a rest element's is the array it collects (...rest: boolean[] carries an array node over boolean, matching the written form), while a variadic spread of an unresolved type (...T) carries the spread type itself.

The element's ? marker; emitted only when true.

The element's ... marker; emitted only when true.

External types whose contributions are filtered out of members.

Filtering is by declaration origin at every granularity — named properties, index signatures, call/construct signatures — so a purely structural external branch (an index-signature-only or callable-only interface) is recorded here exactly like a named-property bag. A declaration-less contribution (the index signature the checker synthesizes for a mapped-type instantiation like Record<string, X> or Partial<Indexed>) is kept in members and records nothing here.

Covers every composition the written type reaches: an intersection or union branch, a bare or indexed-access reference, and a type composed behind a project-local name (type Base = Bag & {…}, a local interface's extends, a local container's accessed property LocalMap['a']). Entries carry the written form with two normalizations: an identifier bound by an import rename at the definition site (import type {Bag as B}) resolves back to the name its module exports, and a type parameter bound inside the descent substitutes its written argument (interface A<T> extends ExtG<T> reached via extends A<string> records ExtG<string>). Each distinct contributor appears once, in source order; a generic reference keeps its arguments. A local name is used only when it hides a definition the walk cannot traverse — a mapped or conditional type.

Names carry no module, so the dedupe is by name alone: two *distinct* external types sharing an exported name (one from each of two packages) collapse to a single entry.

Type members: property signatures, method signatures, index signatures, call/construct signatures.

The exported name also carries a value meaning — a merged value+type symbol (const Foo = z.strictObject({...}) + `type Foo = z.infer<typeof Foo>`, the schema/type pattern), where the type alias wins the declaration slot and the value's own type goes undocumented. Tells consumers the name is importable as a runtime value: import {Foo}, never import type {Foo} (see generateImport).

Module paths (relative to sourceRoot) that re-export this declaration under the same name. The canonical declaration lives in this module's declarations array; these paths are additional import locations for the same thing.

The same edges appear from the re-exporting side as ModuleJson.reExports — use that when asking "what does this module re-export" instead of inverting these arrays. The two can disagree at the margins: a reExports entry whose canonical declaration is @nodocs (or whose module isn't in the analyzed set) has no back-link here.

Consumer note: To build a complete re-export map, scan two fields:

1. alsoExportedFrom on each declaration — same-name re-exports
2. aliasOf on declarations — renamed re-exports (separate declarations)

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

The exported name. Always populated. The default-export slot is named 'default' — that's the symbol's actual name in JS (import {default as X} and ns.default both expose it directly), and import X from 'mod' is sugar for import {default as X}. Consumers branch on name === 'default' to render the sugar form when desired.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

Structured type; absent when typeSignature is the whole story (see TypeJson). The headline case: a union alias's typeSignature prints as its own name (ColorScheme), and this field carries the enumerable members. Type aliases print as their own name for every non-interned type, so the tree is emitted there whatever its shape — the exception is object and function roots, whose content members already carries.

For renamed re-exports (export {foo as bar}), points to the original declaration. This declaration's name is the alias; aliasOf.name is the original name.

For renames out of the default slot (export {default as bar} from './x' where ./x is export default ...), aliasOf.name is 'default' — the canonical's actual symbol name. Consumers locate the canonical by (aliasOf.module, aliasOf.name).

Svelte component exception: when the source is a .svelte file (e.g., export {default as Foo} from './X.svelte'), the canonical's name is the component name (derived from the filename), so aliasOf.name is the component name ('X'), NOT 'default'. Consumers that branch on aliasOf.name === 'default' to detect default-rename should additionally check whether aliasOf.module ends with .svelte.

Different from alsoExportedFrom: aliases create new API surface names, while alsoExportedFrom tracks additional import paths for the same name.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).

Module paths (relative to sourceRoot) that re-export this declaration under the same name. The canonical declaration lives in this module's declarations array; these paths are additional import locations for the same thing.

The same edges appear from the re-exporting side as ModuleJson.reExports — use that when asking "what does this module re-export" instead of inverting these arrays. The two can disagree at the margins: a reExports entry whose canonical declaration is @nodocs (or whose module isn't in the analyzed set) has no back-link here.

Consumer note: To build a complete re-export map, scan two fields:

1. alsoExportedFrom on each declaration — same-name re-exports
2. aliasOf on declarations — renamed re-exports (separate declarations)

Whether extraction failed partway through, leaving some fields missing (e.g., typeSignature, parameters).

Code examples from @example tags.

Related items from @see tags, in raw TSDoc format.

Exceptions from @throws tags.

The exported name. Always populated. The default-export slot is named 'default' — that's the symbol's actual name in JS (import {default as X} and ns.default both expose it directly), and import X from 'mod' is sugar for import {default as X}. Consumers branch on name === 'default' to render the sugar form when desired.

TypeScript modifiers like readonly, static, or protected.

Generic type parameters like <T, U>.

Rune flavor when this variable is initialized with a value-producing reactivity rune.

Default value documented via @default. Useful when the AST initializer is opaque (a call expression, computed value) and the author wants to document the conceptual default.

Structured type; absent when typeSignature is the whole story (see TypeJson).

For renamed re-exports (export {foo as bar}), points to the original declaration. This declaration's name is the alias; aliasOf.name is the original name.

For renames out of the default slot (export {default as bar} from './x' where ./x is export default ...), aliasOf.name is 'default' — the canonical's actual symbol name. Consumers locate the canonical by (aliasOf.module, aliasOf.name).

Svelte component exception: when the source is a .svelte file (e.g., export {default as Foo} from './X.svelte'), the canonical's name is the component name (derived from the filename), so aliasOf.name is the component name ('X'), NOT 'default'. Consumers that branch on aliasOf.name === 'default' to detect default-rename should additionally check whether aliasOf.module ends with .svelte.

Different from alsoExportedFrom: aliases create new API surface names, while alsoExportedFrom tracks additional import paths for the same name.

Internal-API marker from the @internal tag. Presence means the tag was written; an empty string is a bare tag with no trailing prose.

A marker, not an exclusion: @internal means "not stable public API" (TSDoc semantics) while the declaration stays documented — unlike @nodocs, which removes it from output entirely.

Deliberately here rather than in docFields: declarations and members only, not ComponentPropJson (widen to props as a separate additive change if demand appears).

Mutation documentation from @mutates tags (non-standard), mapping keys to descriptions.

Keys are intentionally unvalidated — typically a parameter name, but authors may also use compound paths (this.foo, obj.field) or external state references (globalCache). The schema accepts any string key so consumers can render whatever the author wrote.

Deprecation message from @deprecated tag.

Version introduced, from @since tag.

JSDoc/TSDoc comment.

Full TypeScript type signature.

1-indexed line number in source file. Undefined for synthesized declarations (e.g., alias declarations from renamed re-exports).