www.aleph1.co.uk Git - yaffs-website/blob - node_modules/safe-json-parse/README.md

   1 # safe-json-parse
   2
   3 [![build status][1]][2] [![dependency status][3]][4]
   4
   5 <!-- [![browser support][5]][6] -->
   6
   7 Parse JSON safely without throwing
   8
   9 ## Example (callback)
  10
  11 ```js
  12 var safeParse = require("safe-json-parse/callback")
  13
  14 safeParse("{}", function (err, json) {
  15     /* we have json */
  16 })
  17
  18 safeparse("WRONG", function (err) {
  19     /* we have err! */
  20 })
  21 ```
  22
  23 ## Example (tuple)
  24
  25 ```js
  26 var safeParse = require("safe-json-parse/tuple")
  27
  28 var tuple1 = safeParse("{}")
  29 var json = tuple1[1] /* we have json */
  30
  31 var tuple2 = safeparse("WRONG")
  32 var err = tuple2[0] /* we have err! */
  33
  34 var tuple3 = safeParse(something)
  35 if (tuple3[0]) {
  36     var err = tuple3[0]
  37     // handle err
  38 } else {
  39     var json = tuple3[1]
  40     // handle json
  41 }
  42 ```
  43
  44 ## Example (result)
  45
  46 ```js
  47 var Result = require('rust-result')
  48 var safeParse = require('safe-json-parse/result')
  49
  50 var result1 = safeParse("{}")
  51 var json = Result.Ok(result1) /* we have json */
  52
  53 var result2 = safeparse("WRONG")
  54 var err = Result.Err(result2) /* we have err! */
  55
  56 var result3 = safeParse(something)
  57 if (Result.ifErr(result3)) {
  58     var err = Result.Err(result3)
  59     // handle err
  60 } else if (Result.ifOk(result3)) {
  61     var json = Result.Ok(result3)
  62     // handle json
  63 }
  64 ```
  65
  66 ## Installation
  67
  68 `npm install safe-json-parse`
  69
  70 ## Contributors
  71
  72  - Raynos
  73
  74 ## MIT Licenced
  75
  76
  77   [1]: https://secure.travis-ci.org/Raynos/safe-json-parse.png
  78   [2]: https://travis-ci.org/Raynos/safe-json-parse
  79   [3]: https://david-dm.org/Raynos/safe-json-parse.png
  80   [4]: https://david-dm.org/Raynos/safe-json-parse
  81   [5]: https://ci.testling.com/Raynos/safe-json-parse.png
  82   [6]: https://ci.testling.com/Raynos/safe-json-parse