📝 docs

[techouse]

Description

Add documentation.

Type of change

• New feature (non-breaking change which adds functionality)

How Has This Been Tested?

No tests needed.

Checklist:

• My code follows the style guidelines of this project
• I have performed a self-review of my own code
• I have commented my code, particularly in hard-to-understand areas
• I have made corresponding changes to the documentation
• My changes generate no new warnings
• I have added tests that prove my fix is effective or that my feature works
• New and existing unit tests pass locally with my changes
• Any dependent changes have been merged and published in downstream modules

Summary by CodeRabbit

• New Features
  • Implemented a new workflow for automatically building and deploying updated documentation using Dart SDK.
• Documentation
  • Updated the README.md to enhance the clarity and accuracy of the documentation regarding various decode and encode options.
  • Added comprehensive comments in the codebase to better describe functionality and parameters.
• Bug Fixes
  • Adjusted .gitignore to prevent the doc/ directory from being tracked, ensuring cleaner repository management.
• Refactor
  • Updated the internal representation of boolean values and other types in the codebase to improve consistency and readability.

[coderabbitai]

Walkthrough

The project has introduced a new workflow for building and deploying Dart documentation, updated .gitignore to exclude the doc/ directory, and made extensive alterations to markdown and code documentation to enhance clarity and correctness. Additionally, several files have been modified to refine the presentation of code snippets and update comments.

Changes

Files	Change Summary
.github/workflows/docs.yml, .gitignore	Introduced workflow for Dart documentation and updated ignore rules.
README.md	Updated markdown links and corrected text formatting.
lib/qs_dart.dart, lib/src/models/...	Enhanced code documentation, exported new files, and updated boolean representations in comments.

🐇✨
Oh hark! A fresh doc sprouts anew,
In fields of code where bytes do brew.
With links like chains that softly bind,
A tapestry of thought designed.
Leap forth, dear code, with might and main,
In digital meadows, you'll sustain. 🌼🖥️
🐇✨

---

Recent Review Details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between d304167 and 0a813f9.

Files selected for processing (7)

• .github/workflows/docs.yml (1 hunks)
• .gitignore (1 hunks)
• README.md (49 hunks)
• lib/qs_dart.dart (1 hunks)
• lib/src/models/decode_options.dart (3 hunks)
• lib/src/models/encode_options.dart (3 hunks)
• lib/src/models/undefined.dart (1 hunks)

Files not reviewed due to errors (1)

• .github/workflows/docs.yml (no review received)

Files skipped from review due to trivial changes (5)

• .gitignore
• lib/qs_dart.dart
• lib/src/models/decode_options.dart
• lib/src/models/encode_options.dart
• lib/src/models/undefined.dart

Additional Context Used

LanguageTool (117)

README.md (117)

Near line 1: Possible spelling mistake found.
Context: # qs_dart A query string encoding and decod...

---

Near line 5: Possible spelling mistake found.
Context: ...ecoding library for Dart. Ported from qs for ...

---

Near line 12: Possible spelling mistake found.
Context: ...techouse/qs/actions/workflows/test.yml) [![codecov](https://codecov.io/gh/techouse/qs/grap...

---

Near line 13: Possible spelling mistake found.
Context: ...Pf)](https://codecov.io/gh/techouse/qs) [![Codacy Badge](https://app.codacy.com/project/b...

---

Near line 14: LICENSE must be spelled with a “c” when used as a noun in British English. Use “licence”.
Context: ...&utm_content=&utm_campaign=Badge_grade) [![GitHub Sponsors](https://img.shield...

---

Near line 52: Possible spelling mistake found.
Context: ... brackets []. For example, the string 'foo[bar]=baz' converts to: ```dart expect( QS.de...

---

Near line 70: Possible spelling mistake found.
Context: ...`` You can also nest your [Map]s, like 'foo[bar][baz]=foobarbaz': ```dart expect( QS.dec...

---

Near line 79: Possible missing comma found.
Context: ...oobarbaz'}}}), ); ``` By default, when nesting [Map]s [decode] will only decode up to ...

---

Near line 80: Did you mean “you're” (short for ‘you are’)?
Context: ...ng like 'a[b][c][d][e][f][g][h][i]=j' your resulting [Map] will be: ```dart expec...

---

Near line 103: Possible spelling mistake found.
Context: ...verridden by passing a depth option to [DecodeOptions.depth]: ```dart expect( QS.decode( ...

---

Near line 122: Possible missing comma found.
Context: ... small number. For similar reasons, by default [decode] will only parse up to 1000...

---

Near line 123: Possible spelling mistake found.
Context: .... This can be overridden by passing a [DecodeOptions.parameterLimit] option: ```dart expect...

---

Near line 123: Possible spelling mistake found.
Context: ...overridden by passing a [DecodeOptions.parameterLimit] option: ```dart expect( QS.decode( ...

---

Near line 135: Possible spelling mistake found.
Context: ... bypass the leading question mark, use [DecodeOptions.ignoreQueryPrefix]: ```dart expect( ...

---

Near line 135: Possible spelling mistake found.
Context: ...ading question mark, use [DecodeOptions.ignoreQueryPrefix]: ```dart expect( QS.decode( '?a...

---

Near line 149: Possible spelling mistake found.
Context: ...', 'c': 'd'}, ), ); An optional [DecodeOptions.delimiter] can also be passed: dart...

---

Near line 161: Possible spelling mistake found.
Context: ... equals({'a': 'b', 'c': 'd'}), ); [DecodeOptions.delimiter] can be a [RegExp] too: d...

---

Near line 161: Possible spelling mistake found.
Context: ...`` [DecodeOptions.delimiter] can be a [RegExp] too: ```dart expect( QS.decode( ...

---

Near line 173: Possible spelling mistake found.
Context: ...({'a': 'b', 'c': 'd'}), ); ``` Option [DecodeOptions.allowDots] can be used to enable dot no...

---

Near line 173: Possible spelling mistake found.
Context: ...': 'd'}), ); ``` Option [DecodeOptions.allowDots] can be used to enable dot notation: `...

---

Near line 185: Possible spelling mistake found.
Context: ...als({'a': {'b': 'c'}}), ); ``` Option [DecodeOptions.decodeDotInKeys] can be used to decode ...

---

Near line 185: Possible spelling mistake found.
Context: ...: 'c'}}), ); ``` Option [DecodeOptions.decodeDotInKeys] can be used to decode dots in keys **...

---

Near line 187: Possible spelling mistake found.
Context: ...ode dots in keys Note: it implies [DecodeOptions.allowDots], so [decode] will error if y...

---

Near line 187: Possible spelling mistake found.
Context: ...ys Note: it implies [DecodeOptions.allowDots], so [decode] will error if you set [De...

---

Near line 187: Possible spelling mistake found.
Context: ...ts], so [decode] will error if you set [DecodeOptions.decodeDotInKeys] to true, and `Decod...

---

Near line 187: Possible spelling mistake found.
Context: ...e] will error if you set [DecodeOptions.decodeDotInKeys] to true, and `DecodeOptions.allowDo...

---

Near line 188: Possible spelling mistake found.
Context: ...ptions.decodeDotInKeys] to true, and DecodeOptions.allowDots to false. ```dart expect(...

---

Near line 202: Possible spelling mistake found.
Context: ...', 'last': 'Doe'} }), ); ``` Option [DecodeOptions.allowEmptyLists] can be used to allow e...

---

Near line 202: Possible spelling mistake found.
Context: ...e'} }), ); ``` Option [DecodeOptions.allowEmptyLists] can be used to allow empty [List] valu...

---

Near line 217: Possible spelling mistake found.
Context: ... 'bar': 'baz', }), ); ``` Option [DecodeOptions.duplicates] can be used to change the b...

---

Near line 217: Possible spelling mistake. ‘behavior’ is American English.
Context: ...s.duplicates] can be used to change the behavior when duplicate keys are encountered. `...

---

Near line 267: The correct spelling defined by the Internet Assigned Numbers Authority (IANA) is “UTF-8” or “utf-8”.
Context: ...), ); ``` Some services add an initial utf8=✓ value to forms so that old Internet ...

---

Near line 269: Possible spelling mistake found.
Context: ...cter and detect that a query string or application/x-www-form-urlencoded body was not sent as utf-8, eg. if t...

---

Near line 269: The abbreviation “e.g.” (= for example) requires two periods.
Context: ...lencodedbody was *not* sent as utf-8, eg. if the form had an accept-charset` pa...

---

Near line 272: Possible spelling mistake found.
Context: ...QS supports this mechanism via the [DecodeOptions.charsetSentinel] option. If specified, ...

---

Near line 272: Possible spelling mistake found.
Context: ...s this mechanism via the [DecodeOptions.charsetSentinel] option. If specified, the utf8 param...

---

Near line 274: The correct spelling defined by the Internet Assigned Numbers Authority (IANA) is “UTF-8” or “utf-8”.
Context: ... will be used to switch to [latin1] or [utf8] mode depending on how the checkmark is...

---

Near line 276: Possible spelling mistake found.
Context: ...Important**: When you specify both the [DecodeOptions.charset] option and the [DecodeOptions....

---

Near line 276: Possible spelling mistake found.
Context: ...[DecodeOptions.charset] option and the [DecodeOptions.charsetSentinel] option, the [DecodeOp...

---

Near line 276: Possible spelling mistake found.
Context: ....charset] option and the [DecodeOptions.charsetSentinel] option, the [DecodeOptions.charset] w...

---

Near line 277: Possible spelling mistake found.
Context: ...eOptions.charsetSentinel] option, the [DecodeOptions.charset] will be overridden when the re...

---

Near line 278: It appears that a comma is missing.
Context: ...actual charset can be deduced. In that sense the [DecodeOptions.charset] will behave...

---

Near line 278: Possible spelling mistake found.
Context: ...set can be deduced. In that sense the [DecodeOptions.charset] will behave as the default cha...

---

Near line 306: Possible spelling mistake found.
Context: ... actual character, you can specify the [DecodeOptions.interpretNumericEntities] option as wel...

---

Near line 306: Possible spelling mistake found.
Context: ...ter, you can specify the [DecodeOptions.interpretNumericEntities] option as well: ```dart expect( QS....

---

Near line 321: Possible spelling mistake found.
Context: ... when the charset has been detected in [DecodeOptions.charsetSentinel] mode. ### Decoding Li...

---

Near line 321: Possible spelling mistake found.
Context: ...set has been detected in [DecodeOptions.charsetSentinel] mode. ### Decoding Lists [decode] ca...

---

Near line 391: Possible spelling mistake found.
Context: ... limit can be overridden by passing an [DecodeOptions.listLimit] option: ```dart expect( Q...

---

Near line 391: Possible spelling mistake found.
Context: ...overridden by passing an [DecodeOptions.listLimit] option: ```dart expect( QS.decode( ...

---

Near line 405: Possible spelling mistake found.
Context: ... To disable List parsing entirely, set [DecodeOptions.parseLists] to false. ```dart expect...

---

Near line 405: Possible spelling mistake found.
Context: ...st parsing entirely, set [DecodeOptions.parseLists] to false. ```dart expect( QS.deco...

---

Near line 443: Possible spelling mistake found.
Context: ..., [decode] can parse it by setting the [DecodeOptions.comma] option to true: ```dart expec...

---

Near line 457: Put a space after the comma.
Context: ...] cannot convert nested [Map]s, such as 'a={b:1},{c:d}'_) ### Decoding primitive/scalar ...

---

Near line 459: Possible spelling mistake found.
Context: ... ### Decoding primitive/scalar values (num, bool, null, etc.) By default, al...

---

Near line 459: Possible spelling mistake found.
Context: ...ecoding primitive/scalar values (num, bool, null, etc.) By default, all values...

---

Near line 483: Possible spelling mistake found.
Context: ...fault URI encode the output. [Map]s are stringified as you would expect: ```dart expect( ...

---

Near line 496: Possible spelling mistake found.
Context: ...ncoding can be disabled by setting the [EncodeOptions.encode] option to false: ```dart exp...

---

Near line 510: Possible spelling mistake found.
Context: ...an be disabled for keys by setting the [EncodeOptions.encodeValuesOnly] option to true: ``...

---

Near line 510: Possible spelling mistake found.
Context: ... for keys by setting the [EncodeOptions.encodeValuesOnly] option to true: ```dart expect( Q...

---

Near line 529: Possible spelling mistake found.
Context: ... replaced by a custom [Encoder] set as [EncodeOptions.encoder] option: ```dart expect( QS....

---

Near line 553: Possible spelling mistake found.
Context: ... equals('a[b]=c'), ); ``` _(Note: the [EncodeOptions.encoder] option does not apply if [Enco...

---

Near line 553: Possible spelling mistake found.
Context: ...ions.encoder] option does not apply if [EncodeOptions.encode] is false)_ Similar to [Encod...

---

Near line 555: Possible spelling mistake found.
Context: ...tions.encode] is false)_ Similar to [EncodeOptions.encoder] there is a [DecodeOptions.deco...

---

Near line 555: Possible spelling mistake found.
Context: ... to [EncodeOptions.encoder] there is a [DecodeOptions.decoder] option for [decode] to overrid...

---

Near line 574: Possible spelling mistake found.
Context: ...n [List]s are encoded, they follow the [EncodeOptions.listFormat] option, which defaults to [...

---

Near line 574: Possible spelling mistake found.
Context: ...encoded, they follow the [EncodeOptions.listFormat] option, which defaults to [ListFormat....

---

Near line 574: Possible spelling mistake found.
Context: ....listFormat] option, which defaults to [ListFormat.indices]: ```dart expect( QS.encode(...

---

Near line 588: Possible spelling mistake found.
Context: ... You may override this by setting the [EncodeOptions.indices] option to false, or to be mo...

---

Near line 589: Possible spelling mistake found.
Context: ...o false, or to be more explicit, the [EncodeOptions.listFormat] option to [ListFormat.repea...

---

Near line 589: Possible spelling mistake found.
Context: ...to be more explicit, the [EncodeOptions.listFormat] option to [ListFormat.repeat]: ```dar...

---

Near line 589: Possible spelling mistake found.
Context: ...e [EncodeOptions.listFormat] option to [ListFormat.repeat]: ```dart expect( QS.encode( ...

---

Near line 606: Possible spelling mistake found.
Context: ...a=b&a=c&a=d'), ); ``` You may use the [EncodeOptions.listFormat] option to specify the forma...

---

Near line 606: Possible spelling mistake found.
Context: ... ); ``` You may use the [EncodeOptions.listFormat] option to specify the format of the ou...

---

Near line 662: Possible spelling mistake found.
Context: ...'a=b,c'), ); ``` Note: When using [EncodeOptions.listFormat] set to [ListFormat.comma], ...

---

Near line 662: Possible spelling mistake found.
Context: ...`` Note: When using [EncodeOptions.listFormat] set to [ListFormat.comma], you can als...

---

Near line 662: Possible spelling mistake found.
Context: ...sing [EncodeOptions.listFormat] set to [ListFormat.comma], you can also pass the [EncodeOp...

---

Near line 662: Possible spelling mistake found.
Context: ...stFormat.comma], you can also pass the [EncodeOptions.commaRoundTrip] option set to true or...

---

Near line 662: Possible spelling mistake found.
Context: ...], you can also pass the [EncodeOptions.commaRoundTrip] option set to true or false, to ap...

---

Near line 663: The conjunction “so that” does not have a comma in front.
Context: ..., to append []` on single-item [List]s, so that they can round trip through a parse. W...

---

Near line 681: Possible spelling mistake found.
Context: ...his to use dot notation by setting the [EncodeOptions.allowDots] option to true: ```dart e...

---

Near line 681: Possible spelling mistake found.
Context: ... notation by setting the [EncodeOptions.allowDots] option to true: ```dart expect( Q...

---

Near line 700: Possible spelling mistake found.
Context: ...ation in the keys of [Map] with option [EncodeOptions.encodeDotInKeys] by setting it to `true...

---

Near line 700: Possible spelling mistake found.
Context: ...eys of [Map] with option [EncodeOptions.encodeDotInKeys] by setting it to true: ```dart expe...

---

Near line 717: Possible spelling mistake found.
Context: ...j.last=Doe'), ); ``` Caveat: when [EncodeOptions.encodeValuesOnly] is true as well as ...

---

Near line 717: Possible spelling mistake found.
Context: ...); ``` Caveat: when [EncodeOptions.encodeValuesOnly] is true as well as [EncodeOptions.en...

---

Near line 717: Possible spelling mistake found.
Context: ...encodeValuesOnly] is true as well as [EncodeOptions.encodeDotInKeys], only dots in keys an...

---

Near line 717: Possible spelling mistake found.
Context: ...ly] is true as well as [EncodeOptions.encodeDotInKeys], only dots in keys and nothing else w...

---

Near line 720: Possible spelling mistake found.
Context: ...low empty [List] values by setting the [EncodeOptions.allowEmptyLists] option to true: ```...

---

Near line 720: Possible spelling mistake found.
Context: ...t] values by setting the [EncodeOptions.allowEmptyLists] option to true: ```dart expect( Q...

---

Near line 750: Possible missing article found.
Context: ...'', }, ), equals('a='), ); ``` Key with no values (such as an empty [Map] ...

---

Near line 844: Possible spelling mistake found.
Context: ... want to override the serialization of [DateTime] objects, you can provide a custom [Dat...

---

Near line 844: Possible spelling mistake found.
Context: ...ime] objects, you can provide a custom [DateSerializer] in the [EncodeOptions.serializeDate] o...

---

Near line 845: Possible spelling mistake found.
Context: ...ovide a custom [DateSerializer] in the [EncodeOptions.serializeDate] option: ```dart expect(...

---

Near line 845: Possible spelling mistake found.
Context: ... [DateSerializer] in the [EncodeOptions.serializeDate] option: ```dart expect( QS.encode( ...

---

Near line 872: Possible spelling mistake found.
Context: ...equals('a=7'), ); ``` You may use the [EncodeOptions.sort] option to affect the order of par...

---

Near line 891: Possible spelling mistake found.
Context: ...=y'), ); ``` Finally, you can use the [EncodeOptions.filter] option to restrict which keys w...

---

Near line 978: Possible spelling mistake found.
Context: ...ll` values and empty [String]s use the [EncodeOptions.strictNullHandling] flag. In the resul...

---

Near line 978: Possible spelling mistake found.
Context: ... empty [String]s use the [EncodeOptions.strictNullHandling] flag. In the result string the null...

---

Near line 994: Possible spelling mistake found.
Context: ...ues without = back to null use the [DecodeOptions.strictNullHandling] flag: ```dart expe...

---

Near line 994: Possible spelling mistake found.
Context: ...back tonull` use the [DecodeOptions.strictNullHandling] flag: ```dart expect( QS.decode( ...

---

Near line 1009: Possible spelling mistake found.
Context: ...ering keys with null values, use the [EncodeOptions.skipNulls] flag: ```dart expect( QS....

---

Near line 1009: Possible spelling mistake found.
Context: ...h null values, use the [EncodeOptions.skipNulls] flag: ```dart expect( QS.encode( ...

---

Near line 1024: Possible spelling mistake found.
Context: ..., you can switch to [latin1] using the [EncodeOptions.charset] option: ```dart expect( QS....

---

Near line 1052: Possible spelling mistake found.
Context: ...6%239786%3B'), ); ``` You can use the [EncodeOptions.charsetSentinel] option to announce the...

---

Near line 1052: Possible spelling mistake found.
Context: ... ); ``` You can use the [EncodeOptions.charsetSentinel] option to announce the character by in...

---

Near line 1052: The correct spelling defined by the Internet Assigned Numbers Authority (IANA) is “UTF-8” or “utf-8”.
Context: ... announce the character by including an utf8=✓ parameter with the proper encoding o...

---

Near line 1081: The correct spelling defined by the Internet Assigned Numbers Authority (IANA) is “UTF-8” or “utf-8”.
Context: ... and decoding of characters is done in [utf8], and [latin1] support is also built in...

---

Near line 1082: Possible spelling mistake found.
Context: ...in1] support is also built in via the [EncodeOptions.charset] and [DecodeOptions.charset] pa...

---

Near line 1082: Possible spelling mistake found.
Context: ...n via the [EncodeOptions.charset] and [DecodeOptions.charset] parameter, respectively. If y...

---

Near line 1085: Possible spelling mistake found.
Context: ... a different character set (i.e. [Shift JIS](https://en.wikipedia.org/wiki/Shift_JI...

---

Near line 1085: Possible spelling mistake found.
Context: ...a.org/wiki/Shift_JIS)) you can use the euc package ...

---

Near line 1145: Possible spelling mistake found.
Context: ...d RFC 1738 space encoding The default [EncodeOptions.format] is [Format.rfc3986] which encod...

---

Near line 1145: Unpaired symbol: ‘'’ seems to be missing
Context: ...rmat] is [Format.rfc3986] which encodes ' ' to %20 which is backward compatibl...

---

Near line 1146: Possible spelling mistake found.
Context: ...kward compatible. You can also set the [EncodeOptions.format] to [Format.rfc1738] which encod...

---

Near line 1146: Unpaired symbol: ‘'’ seems to be missing
Context: ...rmat] to [Format.rfc1738] which encodes ' ' to +. ```dart expect( QS.encode( ...

---

Near line 1181: Possible spelling mistake found.
Context: ... --- Special thanks to the authors of qs for ...

---

Near line 1182: Possible spelling mistake found.
Context: ...m/package/qs) for JavaScript: - Jordan Harband - [TJ Holow...

Additional comments not posted (6)

README.md (6)

51-51: The explanation of how to create nested maps is clear and provides a practical example, enhancing the documentation's usability.

---

79-80: Clarify the documentation on nesting limits. It might be helpful to explain why there is a limit and how it affects the use of the library.

---

122-123: The default parsing limit for parameters is well-documented. Consider adding a note on how to adjust this for different use cases.

---

217-217: The documentation on handling duplicates is clear and provides multiple examples, which is excellent for user comprehension.

---

272-278: The explanation of the charsetSentinel option is informative. It might be beneficial to include examples of when this would be necessary or useful.

---

844-845: The custom serialization for DateTime objects is a useful feature. Ensure that the examples provided are correct and test these to verify functionality.

---

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

• X
• Mastodon
• Reddit
• LinkedIn

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>.
  • 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 generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @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.

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 as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

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.

[codecov]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 98.08%. Comparing base (d304167) to head (0a813f9).

Additional details and impacted files

@@           Coverage Diff           @@
##             main      #14   +/-   ##
=======================================
  Coverage   98.08%   98.08%           
=======================================
  Files          13       13           
  Lines         625      625           
=======================================
  Hits          613      613           
  Misses         12       12           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

[coderabbitai]

Actionable comments posted: 0

Out of diff range and nitpick comments (2)

README.md (2)

Line range hint 1-1: Ensure the project title is correctly spelled and appropriately formatted. Consider using a more descriptive title if necessary.

---

187-187: The note on DecodeOptions.decodeDotInKeys is crucial for understanding the interaction between options. Ensure this is highlighted or placed in a noticeable section.