Skip to content

Update README.md about invalid JSON input #220

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jan 30, 2025
Merged

Update README.md about invalid JSON input #220

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
83aa5b1
Update README.md about invalid JSON input
Breus Jan 30, 2025
a8a40ba
Update README.md for invalid JSON input
Breus Jan 30, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,8 @@ Finally, no additional third-party runtime dependencies are required to use thi
* Use **block-list** (`maskKeys`) or **allow-list** (`allowKeys`) for masking
* Limited support for JSONPath masking in both **block-list** (`maskJsonPaths`) and **allow-list** (`allowJsonPaths`)
modes
* Masking a valid JSON will always return a valid JSON
* Masking a valid JSON will always produce a valid JSON. If the input is not valid JSON, processing is guaranteed to
complete, but the resulting masked output is undefined

Note: Since [RFC 8259](https://datatracker.ietf.org/doc/html/rfc8259) dictates that JSON exchanges between systems that
are not part of an enclosed system MUST be encoded using UTF-8, the `json-masker` only supports UTF-8 encoding.
Expand Down Expand Up @@ -779,4 +780,4 @@ JsonMaskerBenchmark.jsonMaskerBytes unicode false 1kb
JsonMaskerBenchmark.jsonMaskerBytes unicode true 1kb 0.1 thrpt 4 214893.887 ± 2143.556 ops/s
JsonMaskerBenchmark.jsonMaskerString unicode false 1kb 0.1 thrpt 4 179303.261 ± 3833.357 ops/s
JsonMaskerBenchmark.jsonMaskerString unicode true 1kb 0.1 thrpt 4 154621.472 ± 2132.929 ops/s
```
```