Code References
===============

Read this page to know how to use primitive-type library.

At present, all methods, type aliases could be imported from path ``primitive_type`` immediately.

Type Aliases
------------

.. automodule:: primitive_type.types

.. note::

   Real API path: ``primitive_type.types``

.. currentmodule:: primitive_type.types

.. autotype:: Primitive
.. autotype:: PrimitiveMap

Type Checker
------------

.. automodule:: primitive_type.checker

.. note::

   Real API path: ``primitive_type.checker``

.. currentmodule:: primitive_type.checker

.. autofunction:: is_primitive
.. autofunction:: is_nested_dict

Type Converter
--------------

.. automodule:: primitive_type.converter

.. note::

   Real API path: ``primitive_type.converter``

.. currentmodule:: primitive_type.converter

.. autoclass:: ConvertError
.. autofunction:: get_primitive_object

.. note::

   Methods :data:`get_str_object`, :data:`get_int_object`, :data:`get_float_object` and :data:`get_bool_object` are simplified method for :data:`get_primitive_object`, they return ``get_primitive_object(val, <type>)`` and confirm the return type is specified type.

.. autofunction:: get_str_object
.. autofunction:: get_int_object
.. autofunction:: get_float_object
.. autofunction:: get_bool_object