JavaScript::Const::Exporter - Convert exported Perl constants to JavaScript
version v0.1.0
Support a project has a module that defines constants for export:
package MyApp::Const; use Exporter qw/ import /; our @EXPORT_OK = qw/ A B /; use constant A => 123; use constant B => "Hello";
Then you can export these constants to JavaScript for use with a web-application's front-end:
use JavaScript::Const::Exporter; my $exporter = JavaScript::Const::Exporter->new( module => 'MyApp::Const', constants => [qw/ A B /], ); my $js = $exporter->process
This will return a string with the JavaScript code:
const A = 123; const B = "Hello";
This module allows you to extract a list of exported constants from a Perl module and generate JavaScript that can be included in a web application, thus allowing you to share constants between Perl and JavaScript.
When true, these will be defined as "var" variables instead of "const" values.
This is the (required) name of the Perl module to include.
This is an array reference of symbols or export tags in the "module"'s namespace to export.
If it is omitted (not recommened), then it will look at the modules @EXPORT_OK list an export all modules.
@EXPORT_OK
You must include sigils of constants. However, the exported JavaScript will omit them, e.g. $NAME will export JavaScript that specifies a constant called NAME.
$NAME
NAME
True if there are "constants".
This is an array reference of paths to add to your @INC, when the "module" is not in the default path.
@INC
True if there are included paths.
When true, pretty-print any arrays or objects.
This is a Package::Stash for the namespace. This is intended for internal use.
This is the content of the module's %EXPORT_TAGS. This is intended for internal use.
%EXPORT_TAGS
This is the JSON encoder. This is intended for internal use.
This method attempts to retrieve the symbols from the module and generate the JavaScript.
On success, it will return a string containing the JavaScript.
When using with Const::Fast::Exporter-based modules, you must explicitly list all of the constants to be exported, as that doesn't provide an @EXPORT_OK variable that can be queried.
Const::Exporter
The development version is on github at https://github.com/robrwo/JavaScript-Const-Exporter and may be cloned from git://github.com/robrwo/JavaScript-Const-Exporter.git
Please report any bugs or feature requests on the bugtracker website https://github.com/robrwo/JavaScript-Const-Exporter/issues
When submitting a bug or request, please include a test-file or a patch to an existing test-file that illustrates the bug or desired feature.
Robert Rothenberg <rrwo@cpan.org>
This software is Copyright (c) 2020 by Robert Rothenberg.
This is free software, licensed under:
The Artistic License 2.0 (GPL Compatible)
To install JavaScript::Const::Exporter, copy and paste the appropriate command in to your terminal.
cpanm
cpanm JavaScript::Const::Exporter
CPAN shell
perl -MCPAN -e shell install JavaScript::Const::Exporter
For more information on module installation, please visit the detailed CPAN module installation guide.