Skip to content

Commit

Permalink
add documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
zurborg authored and yanick committed Jun 29, 2014
1 parent affce58 commit e684193
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions lib/Dancer/Serializer/JSONP.pm
Expand Up @@ -18,3 +18,51 @@ sub serialize {
sub content_type {'application/javascript'} sub content_type {'application/javascript'}


1; 1;
__END__
=head1 NAME
Dancer::Serializer::JSONP - serializer for handling JSONP data
=head1 SYNOPSIS
=head1 DESCRIPTION
This class is a subclass of L<Dancer::Serializer::JSON> with support for JSONP.
In order to use this engine, use the template setting:
serializer: JSONP
This can be done in your config.yml file or directly in your app code with the
B<set> keyword. This serializer will B<not> be used when the serializer is set
to B<mutable>.
All configuration options mentioned in L<Dancer::Serializer::JSON> apply here,
too.
=head1 METHODS
=head2 serialize
Serialize a data structure to a JSON structure with surrounding javascript
callback method. The name of the callback method is obtained from the request
parameter I<callback>.
=head2 deserialize
See L<Dancer::Serializer::JSON#deserialize>.
=head2 content_type
Return 'application/javascript'
=head1 SEE ALSO
L<Dancer::Plugin::CORS> is a modern alternative to JSONP, but with limited
browser support. Today, JSONP can be a serious fallback solution when CORS is
not supported by a browser.
=head1 AUTHOR
David Zurborg, C<< <zurborg at cpan.org> >>

0 comments on commit e684193

Please sign in to comment.