| 1 | # Type Enforcer Math
|
| 2 |
|
| 3 | > An extension of type-enforcer with Math related data types and enforcer functions
|
| 4 | >
|
| 5 | > [![npm][npm]][npm-url]
|
| 6 | [![build][build]][build-url]
|
| 7 | [![coverage][coverage]][coverage-url]
|
| 8 | [![deps][deps]][deps-url]
|
| 9 | [![size][size]][size-url]
|
| 10 | [![vulnerabilities][vulnerabilities]][vulnerabilities-url]
|
| 11 | [![license][license]][license-url]
|
| 12 |
|
| 13 | <br><a name="Installation"></a>
|
| 14 |
|
| 15 | ## Installation
|
| 16 | ```
|
| 17 | npm install type-enforcer-math
|
| 18 | ```
|
| 19 | _Requires Babel 7.2+_
|
| 20 |
|
| 21 | <br><a name="About"></a>
|
| 22 |
|
| 23 | ## About
|
| 24 | type-enforcer-math re-exports everything from [type-enforcer](https://github.com/DarrenPaulWright/type-enforcer), along with:
|
| 25 |
|
| 26 |
|
| 27 | <br>
|
| 28 |
|
| 29 | ## Objects
|
| 30 |
|
| 31 | <dl>
|
| 32 | <dt><a href="docs/is.md">is</a> : <code>object</code></dt>
|
| 33 | <dd><p>Utility functions for checking if something is a particular data type. Includes all the checks from <a href="https://github.com/DarrenPaulWright/type-enforcer">type-enforcer</a>.</p>
|
| 34 | </dd>
|
| 35 | <dt><a href="docs/enforce.md">enforce</a> : <code>object</code></dt>
|
| 36 | <dd><p>Utility functions for enforcing data types. Includes all the enforcers from <a href="https://github.com/DarrenPaulWright/type-enforcer">type-enforcer</a>.</p>
|
| 37 | </dd>
|
| 38 | <dt><a href="docs/method.md">method</a> : <code>object</code></dt>
|
| 39 | <dd><p>Enforce data types and remove common boilerplate code on class methods. Includes all the methods from <a href="https://github.com/DarrenPaulWright/type-enforcer">type-enforcer</a>.</p>
|
| 40 | </dd>
|
| 41 | </dl>
|
| 42 |
|
| 43 | <br>
|
| 44 |
|
| 45 | ## Classes
|
| 46 |
|
| 47 | <dl>
|
| 48 | <dt><a href="docs/Point.md">Point</a></dt>
|
| 49 | <dd><p>Point model with helper methods</p>
|
| 50 | </dd>
|
| 51 | <dt><a href="docs/Vector.md">Vector</a></dt>
|
| 52 | <dd><p>A Euclidean Vector model.</p>
|
| 53 | </dd>
|
| 54 | </dl>
|
| 55 |
|
| 56 | [npm]: https://img.shields.io/npm/v/type-enforcer-math.svg
|
| 57 | [npm-url]: https://npmjs.com/package/type-enforcer-math
|
| 58 | [build]: https://travis-ci.org/DarrenPaulWright/type-enforcer-math.svg?branch=master
|
| 59 | [build-url]: https://travis-ci.org/DarrenPaulWright/type-enforcer-math
|
| 60 | [coverage]: https://coveralls.io/repos/github/DarrenPaulWright/type-enforcer-math/badge.svg?branch=master
|
| 61 | [coverage-url]: https://coveralls.io/github/DarrenPaulWright/type-enforcer-math?branch=master
|
| 62 | [deps]: https://david-dm.org/darrenpaulwright/type-enforcer-math.svg
|
| 63 | [deps-url]: https://david-dm.org/darrenpaulwright/type-enforcer-math
|
| 64 | [size]: https://packagephobia.now.sh/badge?p=type-enforcer-math
|
| 65 | [size-url]: https://packagephobia.now.sh/result?p=type-enforcer-math
|
| 66 | [vulnerabilities]: https://snyk.io/test/github/DarrenPaulWright/type-enforcer-math/badge.svg?targetFile=package.json
|
| 67 | [vulnerabilities-url]: https://snyk.io/test/github/DarrenPaulWright/type-enforcer-math?targetFile=package.json
|
| 68 | [license]: https://img.shields.io/github/license/DarrenPaulWright/type-enforcer-math.svg
|
| 69 | [license-url]: https://npmjs.com/package/type-enforcer-math/LICENSE.md
|