docs: add no-parser README and TypeScript example (fixes #1245)#1261
Open
armorbreak001 wants to merge 1 commit intoasyncapi:masterfrom
Open
docs: add no-parser README and TypeScript example (fixes #1245)#1261armorbreak001 wants to merge 1 commit intoasyncapi:masterfrom
armorbreak001 wants to merge 1 commit intoasyncapi:masterfrom
Conversation
Adds comprehensive documentation for the no-parser bundle: 1. **library/README.md** — Full documentation covering: - What the no-parser bundle is and when to use it - Installation and basic usage examples - Next.js SSR integration example - Standalone (no React) usage example - Type-only import guide (zero runtime cost) - Bundle size comparison table (~57% savings) - API reference for props 2. **library/examples/no-parser-usage.ts** — Runnable TypeScript example: - Pre-parsed document construction - Component usage pattern - Type-only import demonstration Fixes asyncapi#1245
armorbreak001
requested review from
AceTheCreator,
asyncapi-bot-eve,
fmvilas and
magicmatatjahu
as code owners
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
There was a problem hiding this comment.
Welcome to AsyncAPI. Thanks a lot for creating your first pull request. Please check out our contributors guide useful for opening a pull request.
Keep in mind there are also other channels you can use to interact with AsyncAPI community. For more details check out this issue.
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
Fixes #1245
Problem
The no-parser distribution exists but lacks documentation. Users don't understand:
Solution
Added two files:
1.
library/README.md— Comprehensive no-parser guideAsyncApiComponent2.
library/examples/no-parser-usage.ts— Runnable TypeScript demoTesting
@asyncapi/parser