Skip to content

doc: Add noEmptyComposite RunKit example to README #583

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 1 commit into from
Nov 11, 2022
Merged

doc: Add noEmptyComposite RunKit example to README #583

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
30 changes: 29 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,31 @@ let value = JsonURL.parse( "(Hello:Address Bar!!)", { AQF: true });
let string = JsonURL.stringify( value, { AQF: true } );
```

There are additional options available, but that's all you need to get started.
### Options - noEmptyComposite

The JSON→URL specification defines the empty composite value, `()`, because an
empty array is indistinguishable from an empty object. This works well in
practice, generally, but it can lead to counterintuitive results when parsing
JSON→URL text into a language-native object and then stringifying it back
into JSON→URL text; the input text doesn't "round-trip" back to
itself as expected.

The `noEmptyComposite` parse option causes the character sequence `()` to be
parsed as an empty array, and the character sequence `(:)` to be parsed as an
empty object. And the `noEmptyComposite` stringify option instructs
`stringify` to generate those strings appropriately.

[![RunKit: noEmptyComposite](https://img.shields.io/badge/RunKit-noEmptyComposite-ff69b4)][runkit3]

```js
let value = JsonURL.parse( "(Array:(true,false,(nested),()),Object:(nested:(:)))", { AQF: true, noEmptyComposite: true });
let string = JsonURL.stringify( value, { AQF: true, noEmptyComposite: true });
```

### Options - More

There are additional options available. The [typescript definition][dts] file
is a good place to learn more.

JSON→URL has no runtime dependencies.

Expand All @@ -100,6 +124,10 @@ set by default.

[runkit2]: https://runkit.com/jsonurl/hello-aqf

[runkit3]: https://runkit.com/jsonurl/noemptycomposite

[dts]: https://github.com/jsonurl/jsonurl-js/blob/main/jsonurl.d.ts

## License

[![FOSSA Status](https://app.fossa.com/api/projects/git%2Bgithub.com%2Fjsonurl%2Fjsonurl-js.svg?type=large)](https://app.fossa.com/projects/git%2Bgithub.com%2Fjsonurl%2Fjsonurl-js?ref=badge_large)