NAME

Sah::Schema::idx::listed_stock_code - Currently listed stock code in the Indonesian Stock Exchange

VERSION

This document describes version 0.001 of Sah::Schema::idx::listed_stock_code (from Perl distribution Sah-Schemas-Finance-SE-IDX), released on 2021-01-18.

SYNOPSIS

To check data against this schema (requires Data::Sah):

            

              
              
use Data::Sah qw(gen_validator);
my $validator = gen_validator("idx::listed_stock_code*");
say $validator->($data) ? "valid" : "INVALID!";
# Data::Sah can also create validator that returns nice error message string
# and/or coerced value. Data::Sah can even create validator that targets other
# language, like JavaScript. All from the same schema. See its documentation
# for more details.
            
          

To validate function parameters against this schema (requires Params::Sah):

            

              
              
use Params::Sah qw(gen_validator);
sub myfunc {
    my @args = @_;
    state $validator = gen_validator("idx::listed_stock_code*");
    $validator->(\@args);
    ...
}
            
          

To specify schema in Rinci function metadata and use the metadata with Perinci::CmdLine to create a CLI:

            

              
              
# in lib/MyApp.pm
package MyApp;
our %SPEC;
$SPEC{myfunc} = {
    v => 1.1,
    summary => 'Routine to do blah ...',
    args => {
        arg1 => {
            summary => 'The blah blah argument',
            schema => ['idx::listed_stock_code*'],
        },
        ...
    },
};
sub myfunc {
    my %args = @_;
    ...
}
1;
# in myapp.pl
package main;
use Perinci::CmdLine::Any;
Perinci::CmdLine::Any->new(url=>'MyApp::myfunc')->run;
# in command-line
% ./myapp.pl --help
myapp - Routine to do blah ...
...
% ./myapp.pl --version
% ./myapp.pl --arg1 ...
            
          

Sample data:

            

              
              
""  # INVALID
"BBRI"  # valid, becomes "BBRI"
"bbri"  # valid, becomes "BBRI"
"BANKBRI"  # INVALID (Too long)
"KARK"  # INVALID (Not currently listed)
            
          

DESCRIPTION

Code must be listed.

Will be normalized to code in uppercase.

HOMEPAGE

Please visit the project's homepage at https://metacpan.org/release/Sah-Schemas-Finance-SE-IDX.

SOURCE

Source repository is at https://github.com/perlancar/perl-Sah-Schemas-Finance-SE-IDX.

BUGS

Please report any bugs or feature requests on the bugtracker website https://github.com/perlancar/perl-Sah-Schemas-Finance-SE-IDX/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.

AUTHOR

perlancar <perlancar@cpan.org>

COPYRIGHT AND LICENSE

This software is copyright (c) 2021 by perlancar@cpan.org.

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