basis/json/reader/reader-docs.factor

   1 ! Copyright (C) 2006 Chris Double.
   2 ! See http://factorcode.org/license.txt for BSD license.
   3 USING: help.markup help.syntax kernel ;
   4 IN: json.reader
   5
   6 HELP: json>
   7 { $values { "string" "a string in JSON format" } { "object" "a deserialized object" } }
   8 { $description "Deserializes the JSON formatted string into a Factor object. JSON objects are converted to Factor hashtables. All other JSON objects convert to their obvious Factor equivalents." } ;
   9
  10 HELP: read-jsons
  11 { $values { "objects" "a vector of deserialized objects" } }
  12 { $description "Reads JSON formatted strings into a vector of Factor object until the end of the stream is reached. JSON objects are converted to Factor hashtables. All other JSON objects convert to their obvious Factor equivalents." } ;
  13
  14 ARTICLE: "json.reader" "JSON reader"
  15 "The " { $vocab-link "json.reader" } " vocabulary defines a word for parsing strings in JSON format."
  16 { $subsections json> read-jsons } ;
  17
  18 ABOUT: "json.reader"