API Reference TypeCheck v0.13.5

modules

Modules

Fast and flexible runtime type-checking.

Contains TypeCheck specifications for all 'built-in' Elixir types.

Checks whether the value is any atom.

Special type for map-typespecs that contain a combination of fixed keys as well as an optional(...) or required(...) part.

Checks whether the value is a list with the expected elements

Checks whether the value is a map with a required set of keys

Checks whether there is a protocol implementation for this value.

The 'none' type has no inhabitants. In other words, no value will typecheck against this type.

Checks whether the value is a map with a optional set of keys

Type to check whether the given input is any port.

Type to check whether the given input is a reference.

Checks whether the value is any tuple.

Raised when during compilation of types or specifications, an irrecoverable error occurs.

A custom Credo check which supports the @spec! syntax.

Contains a many common types that can be used as overrides for Elixir's standard library's 'Remote Types'.

Implements the defstruct! macro.

Provides macros for 'spectests': spec-automated property-testing.

Working with regular Elixir and Erlang @spec and @type definitions.

Contains the @spec!, @type!, @typep!, @opaque! macros to define runtime-checked function- and type-specifications.

Defines the options that TypeCheck supports on calls to use TypeCheck.

Transforms types into StreamData generators.

Exception to be returned or raised when a value is not of the expected type.

Behaviour to format your own type errors