Skip to content

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

Open
DeepakSinghRajputC wants to merge 5 commits into
asyncapi:masterfrom
DeepakSinghRajputC:deepak/docs-no-parser
Open

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

Conversation

@DeepakSinghRajputC

Copy link
Copy Markdown

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
Copy Markdown

Comment thread docs/usage/no-parser-usage.md
@sonarqubecloud

Copy link
Copy Markdown

@github-actions

Copy link
Copy Markdown
Contributor

This pull request has been automatically marked as stale because it has not had recent activity 😴

It will be closed in 120 days if no further activity occurs. To unstale this pull request, add a comment with detailed explanation.

There can be many reasons why some specific pull request has no activity. The most probable cause is lack of time, not lack of interest. AsyncAPI Initiative is a Linux Foundation project not owned by a single for-profit company. It is a community-driven initiative ruled under open governance model.

Let us figure out together how to push this pull request forward. Connect with us through one of many communication channels we established here.

Thank you for your patience ❤️

@github-actions github-actions Bot added the stale label Aug 19, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

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

2 participants