Skip to content

docs(no-parser): add README + minimal TypeScript example demonstrating Parser Types usage#1246

Open
DeepakSinghRajputC wants to merge 2 commits intoasyncapi:masterfrom
DeepakSinghRajputC:deepak/docs-no-parser
Open

docs(no-parser): add README + minimal TypeScript example demonstrating Parser Types usage#1246
DeepakSinghRajputC wants to merge 2 commits intoasyncapi:masterfrom
DeepakSinghRajputC:deepak/docs-no-parser

Conversation

@DeepakSinghRajputC
Copy link

Description

Changes proposed in this pull request:

  • Add new documentation file docs/usage/no-parser-usage.md explaining how to use the AsyncAPI React component without bundling the parser
  • Include a minimal TypeScript example demonstrating how to import Parser Types (AsyncAPIDocumentInterface, ChannelInterface, etc.) for type safety without including the parser runtime
  • Document the bundle size benefits (150kb vs 700kb) and common use cases for the no-parser approach
  • Add server side parsing example showing how to parse at build time and render on the client
  • Include a common types reference table and troubleshooting section
  • Update docs/README.md to link to the new documentation

Related issue(s)

Resolves #1245

@sonarqubecloud
Copy link

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

Successfully merging this pull request may close these issues.

docs(no-parser): add README + minimal TypeScript example demonstrating Parser Types usage

1 participant