Files
primitive-type/docs/source/api.rst
2026-02-10 12:55:16 +08:00

50 lines
881 B
ReStructuredText

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