sourceafJson::Json.fan


** A simple, easy to use JSON class.
@Js const class Json {
    
    ** The JSON converters.
    const JsonConverters converters
    
    ** Creates a JSON instance.
    new make([Type:JsonConverter]? converters := null, [Str:Obj?]? options := null) {
        this.converters = JsonConverters(converters, options)
    }
    
    private new withConverters(JsonConverters converters) {
        this.converters = converters
    }
    
    ** Converts the given Fantom entity object to its JSON string representation.
    ** 
    ** 'options' is passed to 'JsonWriter', so may just be 'true' for pretty printing. 
    Str toJson(Obj? fantomObj, Obj? options := null) {
        converters.toJson(fantomObj, options)
    }
    
    ** Converts a JSON string to the given Fantom entity type.
    ** If 'fantomType' is 'null', then 'null' is always returned. 
    Obj? fromJson(Str? json, Type? fantomType) {
        converters.fromJson(json, fantomType)
    }
    
    ** Pretty prints the given JSON string or object.
    Str prettyPrint(Obj? fantomObj, Obj? options := null) {
        if (fantomObj is Str)
            fantomObj = JsonReader().readJson(fantomObj)
        
        str := JsonWriter(options).writeJson(fantomObj)
        return str
    }

    ** Converts this Json object to one with the given 'serializableMode'.
    ** 
    ** *Serializable Mode* is where all non-transient fields are converted, regardless of any '@JsonProperty' facets. 
    ** Data from '@JsonProperty' facets, however, are still honoured if defined.
    **  
    **   syntac: fantom
    **   json := Json().withSerializableMode
    This withSerializableMode(Bool on := true) {
        Json(converters.withOptions(["afJson.serializableMode":on]))
    }
    
//  ** A convenience method for those more familiar with Javascipt functions.
//  ** 
//  ** See `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/parse`
//  static Obj? parse(Str? text, |Str? key, Str value|? reviverFn := null) {
//      // TODO implement Json.parse()
//      throw UnsupportedErr()
//  }
//  
//  ** A convenience method for those more familiar with Javascipt functions.
//  ** 
//  ** See `https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON/stringify`
//  static Str stringify(Obj? value, |Str key, Obj, value, Obj obj|? replacerFn, Obj? space := null) {
//      // replacerFn could be a Str array
//      // replacerFn has strange behaviour - see docs
//      // TODO implement Json.stringify()
//      throw UnsupportedErr()
//  }
}