Skip to content

Generating Lit 3 API requires a manual change to the ChildPart export to work. #1112

Closed
@AndrewJakubowicz

Description

@AndrewJakubowicz

Issue

Currently TypeDoc is unable to find the exported type for ChildPart.

Repro

Try and run the lit-3 config without any changes to the built Lit v3 repo. E.g. npm run build --workspace lit-dev-api.
Note the following error: Cannot find ChildPart.

Workaround

In lit-html.d.ts within lit.dev/packages/lit-dev-api/api-data/lit-3/repo/packages/lit-html/development/lit-html.d.ts,

change:

export type { ChildPart };
declare class ChildPart implements Disconnectable {

to

export declare class ChildPart implements Disconnectable {

Fix

This issue is closed once we can automatically build the Lit 3.0 API docs without any manual intervention. Due to workaround this isn't blocking.

Metadata

Metadata

Labels

No labels
No labels

Type

No type

Projects

Status

✅ Done

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions