Search
TypeCheck
v0.13.7
v0.13.6
v0.13.5
v0.13.4
v0.13.3
v0.13.2
v0.13.1
v0.12.4
v0.12.3
v0.12.2
v0.12.1
v0.12.0
v0.11.0
v0.10.8
v0.10.7
v0.10.6
v0.10.5
v0.10.4
v0.10.3
v0.10.2
v0.10.1
v0.10.0
v0.9.0
v0.8.2
v0.8.1
v0.8.0
v0.7.0
v0.6.0
v0.5.0
v0.4.0
v0.3.2
v0.3.1
v0.3.0
v0.2.3
v0.2.2
v0.2.1
v0.2.0
v0.1.2
v0.1.1
v0.1.0
Pages
Modules
Main
TypeCheck
Sections
Types and their syntax
Named Types Type Guards
Manual type-checking
Summary
Types
value/0
Functions
conforms!/3
conforms/3
conforms?/3
dynamic_conforms!/3
dynamic_conforms/3
dynamic_conforms?/3
TypeCheck.Defstruct
Summary
Functions
defstruct!/1
TypeCheck.ExUnit
Summary
Functions
__using__/1
spectest/2
TypeCheck.External
Sections
Experimental
Summary
Functions
apply!/4
apply/4
enforce_spec!/1
fetch_spec/3
fetch_type/3
TypeCheck.Macros
Sections
Usage
Summary
Functions
@/1
opaque!/1
spec!/1
type!/1
typep!/1
TypeCheck.Options
Sections
Setting different options for different dependencies
The supported options in detail
Summary
Types
remote_type/0
t/0
type_override/0
type_overrides/0
Functions
check_overrides!/1
new/0
new/1
TypeCheck.Spec
Summary
Types
problem_tuple/0
t/0
Functions
defined?/3
lookup!/3
lookup/3
TypeCheck.Type
Summary
Types
expandable_type/0
t/0
Functions
build/2
type?/1
Errors and Formatting them
TypeCheck.TypeError
Summary
Types
check_name/0
extra_information/0
location/0
problem_tuple/0
problematic_value/0
t/0
type_checked_against/0
.DefaultFormatter
Summary
Functions
do_format/1
format/2
.Formatter
Summary
Types
problem_tuple/0
Callbacks
format/2
Property Testing
TypeCheck.Type.StreamData
Summary
Functions
arbitrary_primitive_type_gen/0
arbitrary_type_gen/0
fixed_list_gen/0
to_gen/1
wrap_with_gen/2
Builtin Types
TypeCheck.Builtin
Summary
Built-in Elixir types
any/0
arity/0
as_boolean/1
atom/0
binary/0
bitstring/0
boolean/0
byte/0
char/0
charlist/0
fixed_map/1
fixed_tuple/1
float/0
fun/0
function/0
function/1
function/2
identifier/0
integer/0
iodata/0
iolist/0
keyword/0
keyword/1
list/0
list/1
literal/1
map/0
map/2
maybe_improper_list/0
maybe_improper_list/2
mfa/0
module/0
neg_integer/0
no_return/0
non_neg_integer/0
none/0
nonempty_binary/0
nonempty_bitstring/0
nonempty_charlist/0
nonempty_improper_list/2
nonempty_list/0
nonempty_list/1
nonempty_maybe_improper_list/2
number/0
one_of/1
one_of/2
pid/0
port/0
pos_integer/0
range/1
range/2
reference/0
sized_bitstring/1
sized_bitstring/2
struct/0
term/0
timeout/0
tuple/0
Extensions
fancy_map/3
fixed_list/1
guarded_by/2
impl/1
lazy/1
named_type/3
tuple/1
.Any
Summary
Types
problem_tuple/0
t/0
.Atom
Summary
Types
problem_tuple/0
t/0
.Binary
Summary
Types
problem_tuple/0
t/0
.Bitstring
Summary
Types
problem_tuple/0
t/0
.Boolean
Summary
Types
problem_tuple/0
t/0
.CompoundFixedMap
Summary
Types
problem_tuple/0
t/0
.FixedList
Summary
Types
problem_tuple/0
t/0
.FixedMap
Summary
Types
problem_tuple/0
t/0
.FixedTuple
Summary
Types
problem_tuple/0
t/0
.Float
Summary
Types
problem_tuple/0
t/0
.Function
Summary
Types
problem_tuple/0
t/0
Functions
contravariant_wrapper/2
param_check_code/3
.Guarded
Summary
Types
ast/0
t/0
Functions
ast_gen/1
.ImplementsProtocol
Summary
Types
problem_tuple/0
t/0
.Integer
Summary
Types
problem_tuple/0
t/0
.Lazy
Summary
Types
problem_tuple/0
t/0
Functions
lazily_expand_type/1
.List
Summary
Types
problem_tuple/0
t/0
t/1
.Literal
Summary
Types
problem_tuple/0
t/0
.Map
Summary
Types
problem_tuple/0
t/0
.MaybeImproperList
Summary
Types
problem_tuple/0
t/0
t/2
Functions
empty?/1
.NamedType
Summary
Types
problem_tuple/0
t/0
Functions
stringify_name/2
.NegInteger
Summary
Types
problem_tuple/0
t/0
.NonNegInteger
Summary
Types
problem_tuple/0
t/0
.None
Summary
Types
problem_tuple/0
t/0
.Number
Summary
Types
problem_tuple/0
t/0
.OneOf
Summary
Types
problem_tuple/0
t/0
.PID
Summary
Types
problem_tuple/0
t/0
.Port
Summary
Types
problem_tuple/0
t/0
.PosInteger
Summary
Types
problem_tuple/0
t/0
.Range
Summary
Types
problem_tuple/0
t/0
.Reference
Summary
Types
problem_tuple/0
t/0
.SizedBitstring
Summary
Types
problem_tuple/0
t/0
.Tuple
Summary
Types
problem_tuple/0
t/0
Standard Library overrides
TypeCheck.DefaultOverrides
Summary
Functions
default_overrides/0
.Access
Summary
Types
access_fun/2
any_container/0
container/0
get_and_update_fun/2
get_fun/1
key/0
nil_container/0
t/0
value/0
.Agent
Summary
Types
agent/0
name/0
on_start/0
state/0
.Application
Summary
Types
app/0
application_key/0
key/0
restart_type/0
start_type/0
state/0
value/0
.Base
Summary
Types
decode_case/0
encode_case/0
.Calendar
Summary
Types
calendar/0
date/0
datetime/0
day/0
day_fraction/0
day_of_era/0
day_of_week/0
era/0
hour/0
iso_days/0
microsecond/0
minute/0
month/0
naive_datetime/0
second/0
std_offset/0
time/0
time_zone/0
time_zone_database/0
utc_offset/0
week/0
year/0
zone_abbr/0
Functions
calendar_gen/0
.Calendar.ISO
Summary
Types
bce/0
ce/0
day/0
day_of_week/0
day_of_year/0
era/0
hour/0
microsecond/0
minute/0
month/0
quarter_of_year/0
second/0
weekday/0
year/0
year_of_era/0
.Calendar.TimeZoneDatabase
Summary
Types
time_zone_period/0
time_zone_period_limit/0
.Code
Summary
Types
binding/0
.Code.Fragment
Summary
Types
binding/0
.Collectable
Summary
Types
command/0
t/0
.Config.Provider
Summary
Types
config/0
config_path/0
state/0
.Date
Summary
Types
t/0
.Date.Range
Summary
Types
iso_days/0
t/0
.DateTime
Summary
Types
t/0
.DynamicSupervisor
Summary
Types
init_option/0
on_start_child/0
option/0
strategy/0
sup_flags/0
.Enum
Summary
Types
acc/0
default/0
element/0
index/0
t/0
.Enumerable
Summary
Types
acc/0
continuation/0
reducer/0
result/0
slicing_fun/0
t/0
.Erlang.Binary
Summary
Types
cp/0
part/0
.Erlang.Calendar
Summary
Types
date/0
datetime1970/0
datetime/0
time/0
.Erlang.Inet
Summary
Types
port_number/0
.Exception
Summary
Types
arity_or_args/0
kind/0
location/0
non_error_kind/0
stacktrace/0
stacktrace_entry/0
t/0
.File
Summary
Types
encoding_mode/0
erlang_time/0
fd/0
io_device/0
mode/0
posix/0
posix_time/0
stat_options/0
stream_mode/0
.File.Stat
Summary
Types
t/0
.File.Stream
Summary
Types
t/0
.Float
Summary
Types
precision_range/0
.Function
Summary
Types
information/0
.GenServer
Summary
Types
debug/0
from/0
name/0
on_start/0
option/0
options/0
server/0
.IO
Summary
Types
chardata/0
device/0
nodata/0
.IO.ANSI
Summary
Types
ansicode/0
ansidata/0
ansilist/0
.IO.Stream
Summary
Types
t/0
.Inspect
Summary
Types
t/0
.Inspect.Algebra
Summary
Types
t/0
.Inspect.Opts
Summary
Types
color_key/0
t/0
.Kernel.ParallelCompiler
Summary
Types
error/0
line/0
location/0
warning/0
.Keyword
Summary
Types
key/0
t/0
t/1
value/0
.List.Chars
Summary
Types
t/0
.Macro
Summary
Types
captured_remote_function/0
input/0
metadata/0
output/0
t/0
.Macro.Env
Summary
Types
context/0
context_modules/0
file/0
line/0
name_arity/0
t/0
variable/0
.Map
Summary
Types
key/0
value/0
.MapSet
Summary
Types
t/0
t/1
value/0
.Module
Summary
Types
def_kind/0
definition/0
.NaiveDateTime
Summary
Types
t/0
.Node
Summary
Types
state/0
t/0
.OptionParser
Summary
Types
argv/0
errors/0
options/0
parsed/0
.Path
Summary
Types
t/0
.Port
Summary
Types
name/0
.Process
Summary
Types
dest/0
spawn_opt/0
spawn_opts/0
.Range
Summary
Types
limit/0
step/0
t/0
t/2
.Regex
Summary
Types
t/0
.Registry
Summary
Types
body/0
guard/0
guards/0
key/0
keys/0
match_pattern/0
meta_key/0
meta_value/0
registry/0
spec/0
start_option/0
value/0
.Stream
Summary
Types
acc/0
default/0
element/0
index/0
timer/0
.String
Summary
Types
codepoint/0
grapheme/0
pattern/0
t/0
Functions
printable_string_gen/0
.String.Chars
Summary
Types
t/0
.Supervisor
Summary
Types
child/0
child_spec/0
init_option/0
name/0
on_start/0
on_start_child/0
option/0
strategy/0
supervisor/0
.System
Summary
Types
signal/0
time_unit/0
.Task
Summary
Types
t/0
.Task.Supervisor
Summary
Types
option/0
.Time
Summary
Types
t/0
.URI
Summary
Types
port_number/0
t/0
.Version
Summary
Types
build/0
major/0
minor/0
patch/0
pre/0
requirement/0
t/0
version/0
.Version.Requirement
Summary
Types
matchable/0
t/0
Other
TypeCheck.CompileError
TypeCheck.Credo.Check.Readability.Specs
Sections
Explanation
Check-Specific Parameters
General Parameters
Settings
View Source
TypeCheck.CompileError
exception
(TypeCheck v0.12.0)
Raised when during compilation of types or specifications, an irrecoverable error occurs.
×