| 1 |
_ ____ ___ _ _ ____ |
| 2 |
| / ___| / _ \| \ | | _ _ | _ \ __ _ _ __ ___ ___ |
| 3 |
_ | \___ \| | | | \| | (_|_) | |_) / _` | '__/ __|/ _ \ |
| 4 |
| |_| |___) | |_| | |\ | _ _ | __/ (_| | | \__ \ __/ |
| 5 |
\___/|____/ \___/|_| \_| (_|_) |_| \__,_|_| |___/\___| |
| 6 |
|
| 7 |
|
| 8 |
|
| 9 |
This is the README for JSON::Parse version 0.62. |
| 10 |
|
| 11 |
JSON::Parse is a "module" for the Perl computer programming language, a |
| 12 |
library of computer code to install on a computer. This document contains |
| 13 |
four sections: |
| 14 |
|
| 15 |
1. About - what the module does |
| 16 |
|
| 17 |
2. Documentation - how to learn more about the module |
| 18 |
|
| 19 |
3. Installation - how to install this module on a computer |
| 20 |
|
| 21 |
4. Help - what to do if you get stuck |
| 22 |
|
| 23 |
----------------------------------------------------------------------------- |
| 24 |
|
| 25 |
1. ABOUT |
| 26 |
|
| 27 |
JSON::Parse - Parse JSON |
| 28 |
|
| 29 |
A module for parsing JSON. (JSON means "JavaScript Object Notation" |
| 30 |
and it is specified in "RFC 8259".) |
| 31 |
|
| 32 |
JSON::Parse offers the function "parse_json", which takes a string |
| 33 |
containing JSON, and returns an equivalent Perl structure. It also |
| 34 |
offers validation of JSON via "valid_json", which returns true or |
| 35 |
false depending on whether the JSON is correct or not, and |
| 36 |
"assert_valid_json", which produces a descriptive fatal error if the |
| 37 |
JSON is invalid. A function "read_json" reads JSON from a |
| 38 |
file, and there is a safer version of "parse_json" called |
| 39 |
"parse_json_safe" which doesn't throw exceptions. |
| 40 |
|
| 41 |
For special cases of parsing, there are also methods "new" and |
| 42 |
"parse", which create a JSON parsing object and run it on text. See |
| 43 |
"METHODS". |
| 44 |
|
| 45 |
JSON::Parse accepts only UTF-8 as input. See "UTF-8 only" and |
| 46 |
"Handling of Unicode". |
| 47 |
|
| 48 |
----------------------------------------------------------------------------- |
| 49 |
|
| 50 |
2. DOCUMENTATION |
| 51 |
|
| 52 |
You can read the documentation for the module online at the following |
| 53 |
website: |
| 54 |
|
| 55 |
* http://metacpan.org/release/JSON-Parse |
| 56 |
|
| 57 |
(This link goes to the latest version of the module.) |
| 58 |
|
| 59 |
After installing the module, you can read the documentation on your |
| 60 |
computer using |
| 61 |
|
| 62 |
perldoc JSON::Parse |
| 63 |
|
| 64 |
----------------------------------------------------------------------------- |
| 65 |
|
| 66 |
3. INSTALLATION |
| 67 |
|
| 68 |
This module requires Perl version 5.8.9 or later. |
| 69 |
|
| 70 |
To install the module from CPAN, use |
| 71 |
|
| 72 |
cpan JSON::Parse |
| 73 |
|
| 74 |
If you have the App::cpanminus installer, you may prefer |
| 75 |
|
| 76 |
cpanm JSON::Parse |
| 77 |
|
| 78 |
To install the module from the source file, JSON-Parse-0.62.tar.gz, follow |
| 79 |
this sequence of commands: |
| 80 |
|
| 81 |
tar xfz JSON-Parse-0.62.tar.gz |
| 82 |
cd JSON-Parse-0.62 |
| 83 |
perl Makefile.PL |
| 84 |
make |
| 85 |
make install |
| 86 |
|
| 87 |
If you want to test the module before installing it, use "make test" after |
| 88 |
"make" and before "make install". |
| 89 |
|
| 90 |
----------------------------------------------------------------------------- |
| 91 |
|
| 92 |
4. HELP |
| 93 |
|
| 94 |
To get help with the module, you can email the author, Ben Bullock, at |
| 95 |
<[email protected]>. If you think there is a problem in the module, you can |
| 96 |
report a bug at |
| 97 |
|
| 98 |
<https://github.com/benkasminbullock/JSON-Parse/issues>, |
| 99 |
|
| 100 |
or if you want to alter the source code of JSON::Parse, try the public |
| 101 |
repository on github at |
| 102 |
|
| 103 |
<https://github.com/benkasminbullock/JSON-Parse>. |
| 104 |
|
| 105 |
----------------------------------------------------------------------------- |
| 106 |
|
| 107 |
This README was written on Sat Jul 16 08:23:59 2022. |
| 108 |
|
| 109 |
----------------------------------------------------------------------------- |