Skip to content

README: Added note about json/add/exception #332

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
Oct 4, 2017
Merged

README: Added note about json/add/exception #332

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
12 changes: 12 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -150,6 +150,18 @@ require 'json/add/rails'
Both of the additions attempt to require `'json'` (like above) first, if it has
not been required yet.

## Serializing exceptions

The JSON module doesn't extend `Exception` by default. If you convert an `Exception`
object to JSON, it will by default only include the exception message.

To include the full details, you must either load the load the `json/add/core` mentioned
above, or specifically load the exception addition:

```ruby
require 'json/add/exception'
```

## More Examples

To create a JSON document from a ruby data structure, you can call
Expand Down