.\" -*- mode: troff; coding: utf-8 -*-
.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43)
.\"
.\" Standard preamble:
.\" ========================================================================
.de Sp \" Vertical space (when we can't use .PP)
.if t .sp .5v
.if n .sp
..
.de Vb \" Begin verbatim text
.ft CW
.nf
.ne \\$1
..
.de Ve \" End verbatim text
.ft R
.fi
..
.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>.
.ie n \{\
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds C`
.    ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\"
.\" If the F register is >0, we'll generate index entries on stderr for
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD.  Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
.\"
.\" Avoid warning from groff about undefined register 'F'.
.de IX
..
.nr rF 0
.if \n(.g .if rF .nr rF 1
.if (\n(rF:(\n(.g==0)) \{\
.    if \nF \{\
.        de IX
.        tm Index:\\$1\t\\n%\t"\\$2"
..
.        if !\nF==2 \{\
.            nr % 0
.            nr F 2
.        \}
.    \}
.\}
.rr rF
.\" ========================================================================
.\"
.IX Title "JSON::Types 3pm"
.TH JSON::Types 3pm 2024-03-06 "perl v5.38.2" "User Contributed Perl Documentation"
.\" For nroff, turn off justification.  Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
.nh
.SH NAME
JSON::Types \- variable type utility for JSON encoding
.SH SYNOPSIS
.IX Header "SYNOPSIS"
.Vb 3
\&    # Export type functions by default
\&    use JSON;
\&    use JSON::Types;
\&    
\&    print encode_json({
\&        number => number "123",
\&        string => string 123,
\&        bool   => bool "True value",
\&    });
\&    # => {"number":123,"string":"123","bool":true}
\&    
\&    
\&    # Non export interface
\&    use JSON::Types ();
\&    
\&    print encode_json({
\&        number => JSON::Types::number "123",
\&        string => JSON::Types::string 123,
\&        bool   => JSON::Types::bool "True value",
\&    });
.Ve
.SH DESCRIPTION
.IX Header "DESCRIPTION"
The type mappings between JSON and Perl is annoying things. For example,
.PP
.Vb 1
\&    use JSON;
\&    
\&    my $number = 123;
\&    
\&    warn "[DEBUG] number:$number\en" if $ENV{DEBUG};
\&    
\&    print encode_json([ $number ]);
.Ve
.PP
Output of this code depends on whether DEBUG environment is set or not.
If set, result is \f(CW\*(C`[123]\*(C'\fR. If not to set, result is \f(CW\*(C`["123"]\*(C'\fR.
This is normal behaviour on Perl though, it sometimes causes unexpected JSON results.
.PP
There is a solution about this:
.PP
.Vb 1
\&    print encode_json([ $number + 0 ]);
.Ve
.PP
This code always outputs \f(CW\*(C`[123]\*(C'\fR.
But the code is a bit ugly and not readable at all.
.PP
This module provides some functions to fix this variable types issue:
.PP
.Vb 3
\&    number $foo;  # is always number
\&    string $foo;  # is always string
\&    bool   $foo;  # is always bool
.Ve
.PP
You can fix above code by using this module like this:
.PP
.Vb 2
\&    use JSON;
\&    use JSON::Types;
\&    
\&    my $number = 123;
\&    
\&    warn "[DEBUG] number:$number\en" if $ENV{DEBUG};
\&    
\&    print encode_json([ number $number ]);
.Ve
.SH FUNCTIONS
.IX Header "FUNCTIONS"
There is three functions and all functions is exported by default.
.PP
If you don't want this exported functions, pass empty list to use line:
.PP
.Vb 1
\&    use JSON::Types ();
.Ve
.PP
You should specify full function name when this case, like \f(CW\*(C`JSON::Types::number $foo\*(C'\fR or etc.
.SS string
.IX Subsection "string"
.SS number
.IX Subsection "number"
.SS bool
.IX Subsection "bool"
.SH "BEHAVIOURS ON UNEXPECTED ARGS"
.IX Header "BEHAVIOURS ON UNEXPECTED ARGS"
.SS "string(undef), number(undef) returns undef, bool(undef) returns false."
.IX Subsection "string(undef), number(undef) returns undef, bool(undef) returns false."
Passing undefined variable to string and number function is returns undef. If you doesn't prefer this, have to treat this like following:
.PP
.Vb 1
\&    number $undef_possible_value // 0
.Ve
.PP
This code returns 0 if variable is undef.
.SS number($string)
.IX Subsection "number($string)"
Passing not numeric variable to number function is returns 0, but a warning will be occurred.
.SH AUTHOR
.IX Header "AUTHOR"
Daisuke Murase <typester@cpan.org>
.SH "COPYRIGHT AND LICENSE"
.IX Header "COPYRIGHT AND LICENSE"
Copyright (c) 2012 Daisuke Murase. All rights reserved.
.PP
This program is free software; you can redistribute
it and/or modify it under the same terms as Perl itself.
.PP
The full text of the license can be found in the
LICENSE file included with this module.