docs/imporve documentaions - #11
Merged
Merged
Conversation
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
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.
This pull request introduces several improvements focused on documentation, API clarity, and internal code quality. The main highlights are the addition of a detailed performance guide, expanded and clarified option types with documentation comments, and minor internal consistency improvements. These changes enhance usability, maintainability, and discoverability for users and contributors.
Documentation improvements:
docs/performance.mdfile with real-world memory benchmarks, code samples, and explanations for various high-throughput streaming scenarios using the library.package.jsonkeywords to improve discoverability and updated the description for clarity.API documentation and type improvements:
JSONTextDecoderOptions,JSONTextEncoderOptions,JSONTextDecoderStreamOptions,JSONTextEncoderStreamOptions,JSONTextLineStreamOptions,JSONTextSelectorStreamOptions). This clarifies usage and available options for each API. [1] [2] [3] [4] [5] [6]Kindtype insrc/types/kind.tsto describe all possible JSON token kinds.src/types/options.ts, making option inheritance and available flags clearer.Internal consistency and bug fixes:
TokenandValueclasses (this.bytes→this.#bytes,this.kind→this.#kind) to ensure encapsulation and correctness. [1] [2] [3] [4]Valueto reference RFC 8785 explicitly.