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             # ABSTRACT: Types and type tools for Search::Typesense
4              
5 4     4   2158010 use strict;
  4         32  
  4         120  
6 4     4   24 use warnings;
  4         15  
  4         130  
7 4     4   2500 use Type::Library -base;
  4         141291  
  4         98  
8 4     4   3868 use Type::Utils -all;
  4         37537  
  4         42  
9              
10             # this gets us compile and compile_named
11 4     4   12212 use Type::Params;
  4         318061  
  4         47  
12              
13             our $VERSION = '0.08';
14              
15             our @EXPORT_OK;
16              
17             BEGIN {
18 4     4   1975 extends qw(
19             Types::Standard
20             Types::Common::Numeric
21             Types::Common::String
22             );
23 4         366773 push @EXPORT_OK => (
24             'compile', # from Type::Params
25             'compile_named', # from Type::Params
26             );
27             }
28              
29             1;
30              
31             __END__
32              
33             =pod
34              
35             =encoding UTF-8
36              
37             =head1 NAME
38              
39             Search::Typesense::Types - Types and type tools for Search::Typesense
40              
41             =head1 VERSION
42              
43             version 0.08
44              
45             =head1 SYNOPSIS
46              
47             package Search::Typesense;
48              
49             use Search::Typesense::Types qw(
50             ArrayRef
51             Dict
52             Enum
53             HashRef
54             InstanceOf
55             Str
56             compile
57             );
58              
59             =head1 DESCRIPTION
60              
61             This is an internal package for L<Search::Typesense>. It's probably overkill,
62             but if we want to be more strict later, this gives us the basics.
63              
64             =head1 TYPE LIBRARIES
65              
66             We automatically include the types from the following:
67              
68             =over
69              
70             =item * L<Types::Standard>
71              
72             =item * L<Types::Common::Numeric>
73              
74             =item * L<Types::Common::String>
75              
76             =back
77              
78             =head1 EXTRAS
79              
80             The following extra functions are exported on demand or if use the C<:all> export tag.
81              
82             =over
83              
84             =item * C<compile>
85              
86             See L<Type::Params>
87              
88             =item * C<compile_named>
89              
90             See L<Type::Params>
91              
92             =item * C<slurpy>
93              
94             See L<Types::Standard>
95              
96             =back
97              
98             =head1 AUTHOR
99              
100             Curtis "Ovid" Poe <ovid@allaroundtheworld.fr>
101              
102             =head1 COPYRIGHT AND LICENSE
103              
104             This software is copyright (c) 2021 by Curtis "Ovid" Poe.
105              
106             This is free software; you can redistribute it and/or modify it under
107             the same terms as the Perl 5 programming language system itself.
108              
109             =cut