Skip to content
New issue

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

Node types don't appear to be exported in an ergonomic way #1103

Open
justinfagnani opened this issue Jan 11, 2024 · 4 comments
Open

Node types don't appear to be exported in an ergonomic way #1103

justinfagnani opened this issue Jan 11, 2024 · 4 comments

Comments

@justinfagnani
Copy link

I've been trying to figure out how to import the node types (Node, Document, etc) and can't figure out any way to do it except via the DefaultTreeAdapter type and an index expression, which is quite non-obvious and tedious:

import {parse, type DefaultTreeAdapterMap} from 'parse5';

type Document = DefaultTreeAdapterMap['document'];
type Node = DefaultTreeAdapterMap['node'];

The API docs mention the DefaultTreeAdapterTypes namespace, but while that's in the source in index.ts:

export type * as DefaultTreeAdapterTypes from './tree-adapters/default.js';

That line doesn't appear in my installed dist/index.d.ts at least in version 7.1.2.

I can't import the type's exported from parse5/dist/tree-adapters/default.js because that file isn't in the package exports.

@43081j
Copy link
Collaborator

43081j commented Jan 11, 2024

FYI the @parse5/tools package does re-export the default tree adapter types at least (by indexing into it like you mentioned)

Possibly could use that to make it a bit easier

Would be good to know why the export doesn't show up still

@justinfagnani
Copy link
Author

The individual node types don't show up because they just aren't exported in any public module. Is there a reason that parse5/tree-adapters/default.js isn't exported?

@43081j
Copy link
Collaborator

43081j commented Jan 12, 2024

if i remember correctly, it was mostly because there are multiple tree adapters. so it didn't seem to make much sense exporting the default one's types (since everything else in the package is generic)

i'm not sure though tbh. i ran into the same so i just added it to the @parse5/tools package in the end (import {Element} from '@parse5/tools')

@justinfagnani
Copy link
Author

Well, the other tree adapters should export their types too :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants