Skip to content

@briklab/parsee FAQ & Gotchas

FAQ

What does parsee return?

It returns ParsedItem entries for declarations discovered in source.

Can I control output shape?

Yes. Use ParseOptions to include or skip specific metadata fields.

Can I parse TypeScript snippets from strings?

Yes. Pass source text directly to parseWithTsMorph.

Gotchas

Option Coverage

If fields look missing in output, check whether the corresponding ParseOptions key is enabled.

Provide a File Name

Pass fileName (for example demo.ts) to improve TypeScript context during parsing.

Circular Import Workarounds

Use _parser only when you need the underscore variant for circular dependency cases.

Mixed JS/TS Inputs

Different syntax patterns can affect extracted metadata quality. Validate with small smoke tests first.

Diagram

100%Ctrl + wheel to zoom