Add example of using mapping to parse array (#5993)

Currently json documentation is missing a very common example of parsing array of objects using mapping. This PR add this example into documentation (in section about using `from_json`).
crystal-lang · Apr 23, 2018 · 1c4e4e8 · 1c4e4e8
1 parent 6564d6c
commit 1c4e4e8
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/src/json/mapping.cr b/src/json/mapping.cr
@@ -24,6 +24,10 @@ module JSON
   # house.address  # => "Crystal Road 1234"
   # house.location # => #<Location:0x10cd93d80 @lat=12.3, @lng=34.5>
   # house.to_json  # => %({"address":"Crystal Road 1234","location":{"lat":12.3,"lng":34.5}})
+  #
+  # houses = Array(House).from_json(%([{"address": "Crystal Road 1234", "location": {"lat": 12.3, "lng": 34.5}}]))
+  # houses.size    # => 1
+  # houses.to_json # => [{"address":"Crystal Road 1234","location":{"lat":12.3,"lng":34.5}}]
   # ```
   #
   # ### Usage