Skip to content

Update README.md's Type Mappings #95

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

Open
daninus14 wants to merge 1 commit into
base: develop
Choose a base branch
from
Open

Update README.md's Type Mappings #95

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
28 changes: 15 additions & 13 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,19 +113,21 @@ If you have an up to date version of `uiop` installed:

### Type Mappings

jzon cannonically maps types per the following chart:

| JSON | CL |
|--------|-------------------------|
| true | symbol `t` |
| false | symbol `nil` |
| null | symbol `null` |
| number | integer or double-float |
| string | simple-string |
| array | simple-vector |
| object | hash-table (equal) |

**Note** the usage of symbol `cl:null` as a sentinel for JSON `null`
By default jzon maps types per the following chart:

| JSON | CL |
|--------|------------------------------------------|
| true | symbol `t` |
| false | symbol `nil`<sup>Note 2</sup> |
| null | symbol `null` |
| number | integer or double-float |
| string | simple-string |
| array | simple-vector |
| object | hash-table (equal) |

**Note 1** the usage of symbol `cl:null` as a sentinel for JSON `null`

**Note 2** In `standard-objects` aka CLOS classes `nil` will be serialized to `null` unless `:type boolean` is specified in the slot options for that slot. See https://github.com/Zulu-Inuoe/jzon#standard-object for details.

When writing, additional values are supported. Please see the section [jzon:stringify](#jzonstringify).

Expand Down
Loading