File Coverage

blib/lib/Search/Typesense/Types.pm
Criterion Covered Total %
statement 17 17 100.0
branch n/a
condition n/a
subroutine 6 6 100.0
pod n/a
total 23 23 100.0


line stmt bran cond sub pod time code
1             package Search::Typesense::Types;
2              
3 4     4   30 use strict;
  4         10  
  4         122  
4 4     4   24 use warnings;
  4         10  
  4         123  
5 4     4   2224 use Type::Library -base;
  4         142545  
  4         54  
6 4     4   4296 use Type::Utils -all;
  4         38410  
  4         50  
7              
8             # this gets us compile and compile_named
9 4     4   12650 use Type::Params;
  4         322925  
  4         57  
10              
11             our $VERSION = '0.06';
12              
13             our @EXPORT_OK;
14              
15             BEGIN {
16 4     4   2212 extends qw(
17             Types::Standard
18             Types::Common::Numeric
19             Types::Common::String
20             );
21 4         379441 push @EXPORT_OK => (
22             'compile', # from Type::Params
23             'compile_named', # from Type::Params
24             );
25             }
26              
27             1;
28              
29             __END__
30              
31             =head1 NAME
32              
33             Search::Typesense::Types - Keep our type tools orgnanized
34              
35             =head1 SYNOPSIS
36              
37             package Search::Typesense;
38              
39             use Search::Typesense::Types qw(
40             ArrayRef
41             Dict
42             Enum
43             HashRef
44             InstanceOf
45             Str
46             compile
47             );
48              
49             =head1 DESCRIPTION
50              
51             This is an internal package for L<Search::Typesense>. It's probably overkill,
52             but if we want to be more strict later, this gives us the basics.
53              
54             =head1 TYPE LIBRARIES
55              
56             We automatically include the types from the following:
57              
58             =over
59              
60             =item * L<Types::Standard>
61              
62             =item * L<Types::Common::Numeric>
63              
64             =item * L<Types::Common::String>
65              
66             =back
67              
68             =head1 EXTRAS
69              
70             The following extra functions are exported on demand or if use the C<:all> export tag.
71              
72             =over
73              
74             =item * C<compile>
75              
76             See L<Type::Params>
77              
78             =item * C<compile_named>
79              
80             See L<Type::Params>
81              
82             =item * C<slurpy>
83              
84             See L<Types::Standard>
85              
86             =back