.\" Automatically generated by Pod::Man 4.14 (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
..
.\" Set up some character translations and predefined strings.  \*(-- will
.\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
.\" double quote, and \*(R" will give a right double quote.  \*(C+ will
.\" give a nicer C++.  Capital omega is used to do unbreakable dashes and
.\" therefore won't be available.  \*(C` and \*(C' expand to `' in nroff,
.\" nothing in troff, for use with C<>.
.tr \(*W-
.ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
.ie n \{\
.    ds -- \(*W-
.    ds PI pi
.    if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
.    if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\"  diablo 12 pitch
.    ds L" ""
.    ds R" ""
.    ds C` ""
.    ds C' ""
'br\}
.el\{\
.    ds -- \|\(em\|
.    ds PI \(*p
.    ds L" ``
.    ds R" ''
.    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 "JE::String 3pm"
.TH JE::String 3pm "2023-08-25" "perl v5.36.0" "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"
JE::String \- JavaScript string value
.SH "SYNOPSIS"
.IX Header "SYNOPSIS"
.Vb 2
\&  use JE;
\&  use JE::String;
\&
\&  $j = JE\->new;
\&
\&  $js_str = new JE::String $j, "etetfyoyfoht";
\&
\&  $perl_str = $js_str\->value;
\&
\&  $js_str\->to_object; # retuns a new JE::String::Object;
.Ve
.SH "DESCRIPTION"
.IX Header "DESCRIPTION"
This class implements JavaScript string values for \s-1JE.\s0 The difference
in use between this and JE::Object::String is that that module implements
string
\&\fIobjects,\fR while this module implements the \fIprimitive\fR values.
.PP
The stringification operator is overloaded.
.SH "THE FUNCTION"
.IX Header "THE FUNCTION"
There are two exportable functions, \f(CW\*(C`surrogify\*(C'\fR and \f(CW\*(C`desurrogify\*(C'\fR, which
convert characters outside the \s-1BMP\s0 into surrogate pairs, and convert
surrogate pairs in the string input argument into the characters they
represent, respectively, and return the modified string. E.g.:
.PP
.Vb 1
\&  use JE::String qw \*(Aqdesurrogify surrogify\*(Aq;
\&  
\&  {
\&          no warnings \*(Aqutf8\*(Aq;
\&          $str = "\ex{d834}\ex{dd2b}";
\&  }
\&
\&  $str = desurrogify $str;  # $str now contains "\ex{1d12b}" (double flat)
\&  $str = surrogify $str;    # back to "\ex{d834}\ex{dd2b}"
.Ve
.SH "SEE ALSO"
.IX Header "SEE ALSO"
.IP "\s-1JE\s0" 4
.IX Item "JE"
.PD 0
.IP "JE::Types" 4
.IX Item "JE::Types"
.IP "JE::Object::String" 4
.IX Item "JE::Object::String"