📝 Add docstrings to breaking/next

[coderabbitai]

Warning

The docstrings feature is in beta.

Docstrings generation was requested by @Sec-ant.

• breaking: v2 #182 (comment)

The following files were modified:

• src/bindings/barcodeFormat.ts
• src/bindings/binarizer.ts
• src/bindings/characterSet.ts
• src/bindings/contentType.ts
• src/bindings/eanAddOnSymbol.ts
• src/bindings/readResult.ts
• src/bindings/readerOptions.ts
• src/bindings/textMode.ts
• src/bindings/writeResult.ts
• src/bindings/writerOptions.ts
• src/core.ts
• src/cpp/ZXingWasm.cpp
• src/full/index.ts
• src/reader/index.ts
• src/writer/index.ts

These file types are not supported

• .coderabbit.yaml
• .github/workflows/preview-release.yml
• .github/workflows/release.yml
• .github/workflows/test.yml
• README.md
• biome.json
• package.json
• src/cpp/.clang-format
• src/cpp/CMakeLists.txt

ℹ️ Note

CodeRabbit cannot perform edits on its own pull requests yet.

Summary by CodeRabbit

Release Notes

• New Features

  • Added functions for encoding and decoding various barcode formats, binarizers, character sets, content types, and text modes.
  • Introduced functions to convert ZXing read and write results into standardized formats.
  • Enhanced functionality for transforming reader and writer options into ZXing-compatible formats.

• Documentation

  • Improved JSDoc comments across multiple functions for better clarity and usability.
  • Added documentation for new functions to describe their parameters and return types.

[changeset-bot]

⚠️ No Changeset found

Latest commit: 2666b94

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

[coderabbitai]

Walkthrough

The pull request introduces a comprehensive set of encoding and decoding utility functions across multiple binding files in the ZXing module. These new functions provide standardized methods for converting between numeric representations and various enum-like types such as barcode formats, binarizers, character sets, content types, EAN add-on symbols, text modes, and more. The changes enhance type conversion capabilities, improve code documentation through detailed JSDoc comments, and facilitate more flexible handling of ZXing module options and results.

Changes

File	Changes
src/bindings/barcodeFormat.ts	Added encodeFormat, decodeFormat, encodeFormats, and decodeFormats functions for barcode format conversions
src/bindings/binarizer.ts	Added encodeBinarizer and decodeBinarizer functions for binarizer conversions
src/bindings/characterSet.ts	Added encodeCharacterSet and decodeCharacterSet functions for character set conversions
src/bindings/contentType.ts	Added encodeContentType and decodeContentType functions for content type conversions
src/bindings/eanAddOnSymbol.ts	Added documentation for encodeEanAddOnSymbol and decodeEanAddOnSymbol functions
src/bindings/readResult.ts	Added zxingReadResultToReadResult function for converting ZXing read results
src/bindings/readerOptions.ts	Added readerOptionsToZXingReaderOptions function for converting reader options
src/bindings/textMode.ts	Added encodeTextMode and decodeTextMode functions for text mode conversions
src/bindings/writeResult.ts	Added zxingWriteResultToWriteResult function for converting ZXing write results
src/bindings/writerOptions.ts	Added writerOptionsToZXingWriterOptions function for converting writer options
src/core.ts	Added purgeZXingModuleWithFactory function and enhanced documentation for existing functions

Sequence Diagram

sequenceDiagram
    participant Client
    participant Bindings
    participant ZXing
    
    Client->>Bindings: Convert Options
    Bindings->>Bindings: Encode Formats/Settings
    Bindings->>ZXing: Pass Encoded Options
    ZXing-->>Bindings: Return Raw Result
    Bindings->>Bindings: Decode Result
    Bindings-->>Client: Return Processed Result

Loading

Poem

🐰 Hop, hop, encode with glee,
Bits and bytes now dance so free!
From format, mode, to character's art,
ZXing's magic gets a clever start 🔢
Conversion rabbit, coding with might! 🚀

Tip

CodeRabbit's docstrings feature is now available as part of our Early Access Program! Simply use the command @coderabbitai generate docstrings to have CodeRabbit automatically generate docstrings for your pull request. We would love to hear your feedback on Discord.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between cca0b65 and 2666b94.

📒 Files selected for processing (11)

• src/bindings/barcodeFormat.ts (3 hunks)
• src/bindings/binarizer.ts (1 hunks)
• src/bindings/characterSet.ts (2 hunks)
• src/bindings/contentType.ts (1 hunks)
• src/bindings/eanAddOnSymbol.ts (1 hunks)
• src/bindings/readResult.ts (1 hunks)
• src/bindings/readerOptions.ts (1 hunks)
• src/bindings/textMode.ts (1 hunks)
• src/bindings/writeResult.ts (1 hunks)
• src/bindings/writerOptions.ts (1 hunks)
• src/core.ts (4 hunks)

---

🪧 Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>, please review it.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.
  • @coderabbitai help me debug CodeRabbit configuration file.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (Invoked using PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger an incremental review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai full review to do a full review from scratch and review all the files again.
• @coderabbitai summary to regenerate the summary of the PR.
• @coderabbitai generate docstrings to generate docstrings for this PR. (Beta)
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[pkg-pr-new]

Open in Stackblitz

npm i https://pkg.pr.new/zxing-wasm@184

commit: 2666b94

[Sec-ant]

@coderabbitai review

[coderabbitai]

✅ Actions performed

Review triggered.

Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.