View on
MetaCPAN is shutting down
For details read Perl NOC. After June 25th this page will redirect to
Justin Hunter > JSON-Any-1.24 > JSON::Any



Annotate this POD


Open  1
View/Report Bugs
Module Version: 1.24   Source   Latest Release: JSON-Any-1.39


JSON::Any - Wrapper Class for the various JSON classes.


Version 1.24


This module will provide a coherent API to bring together the various JSON modules currently on CPAN. This module will allow you to code to any JSON API and have it work regardless of which JSON module is actually installed.

        use JSON::Any;

        my $j = JSON::Any->new;

        $json = $j->objToJson({foo=>'bar', baz=>'quux'});
        $obj = $j->jsonToObj($json);


        $json = $j->encode({foo=>'bar', baz=>'quux'});
        $obj = $j->decode($json);


        $json = $j->Dump({foo=>'bar', baz=>'quux'});
        $obj = $j->Load($json);


        $json = $j->to_json({foo=>'bar', baz=>'quux'});
        $obj = $j->from_json($json);

or without creating an object:

        $json = JSON::Any->objToJson({foo=>'bar', baz=>'quux'});
        $obj = JSON::Any->jsonToObj($json);

On load, JSON::Any will find a valid JSON module in your @INC by looking for them in this order:


And loading the first one it finds.

You may change the order by specifying it on the use JSON::Any line:

        use JSON::Any qw(DWIW XS JSON);

Specifying an order that is missing one of the modules will prevent that module from being used:

        use JSON::Any qw(DWIW XS JSON);

This will check in that order, and will never attempt to load JSON::Syck. This can also be set via the $ENV{JSON_ANY_ORDER} environment variable.

JSON::Syck has been deprecated by it's author, but in the attempt to still stay relevant as a "Compat Layer" JSON::Any still supports it. This support however has been made optional starting with JSON::Any 1.19. In deference to a bug request starting with JSON 1.20 JSON::Syck and other deprecated modules will still be installed, but only as a last resort and will now include a warning.

    use JSON::Any qw(Syck XS JSON); 



WARNING: If you call JSON::Any with an empty list

    use JSON::Any ();

It will skip the JSON package detection routines and will die loudly that it couldn't find a package.



Will take any of the parameters for the underlying system and pass them through. However these values don't map between JSON modules, so, from a portability standpoint this is really only helpful for those paramters that happen to have the same name. This will be addressed in a future release.

The one parameter that is universally supported (to the extent that is supported by the underlying JSON modules) is utf8. When this parameter is enabled all resulting JSON will be marked as unicode, and all unicode strings in the input data structure will be preserved as such.

Also note that the allow_blessed parameter is recognised by all the modules that throw exceptions when a blessed reference is given them meaning that setting it to true works for all modules. Of course, that means that you cannot set it to false intentionally in order to always get such exceptions.

The actual output will vary, for example JSON will encode and decode unicode chars (the resulting JSON is not unicode) wheras JSON::XS will emit unicode JSON.


Takes no arguments, returns a string indicating which JSON Module is in use.


Takes no arguments, if called on an object returns the internal JSON::* object in use. Otherwise returns the JSON::* package we are using for class methods.


Takes no arguments, returns the special value that the internal JSON object uses to map to a JSON true boolean.


Takes no arguments, returns the special value that the internal JSON object uses to map to a JSON false boolean.


Takes a single argument, a hashref to be converted into JSON. It returns the JSON text in a scalar.


Aliases for objToJson, can be used interchangeably, regardless of the underlying JSON module.


Takes a single argument, a string of JSON text to be converted back into a hashref.


Aliases for jsonToObj, can be used interchangeably, regardless of the underlying JSON module.


Chris Thompson cthom at

Chris Prather chris at

Robin Berjon robin at

Marc Mims marc at

Tomas Doran bobtfish at


Please report any bugs or feature requests to bug-json-any at, or through the web interface at I will be notified, and then you'll automatically be notified of progress on your bug as I make changes.


This module came about after discussions on about the fact that there were now six separate JSON perl modules with different interfaces.

In the spirit of Class::Any, JSON::Any was created with the considerable help of Matt 'mst' Trout.

Simon Wistow graciously supplied a patch for backwards compat with JSON::XS versions previous to 2.01

San Dimas High School Football Rules!


Copyright 2007-2009 Chris Thompson, some rights reserved.

This program is free software; you can redistribute it and/or modify it under the same terms as Perl itself.

syntax highlighting: