HopefulLlama/UnitTestSCAD

View on GitHub
docs/index.js.html

Summary

Maintainability
Test Coverage
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: index.js</title>

    <script src="scripts/prettify/prettify.js"> </script>
    <script src="scripts/prettify/lang-css.js"> </script>
    <!--[if lt IE 9]>
      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
    <![endif]-->
    <link type="text/css" rel="stylesheet" href="styles/prettify-tomorrow.css">
    <link type="text/css" rel="stylesheet" href="styles/jsdoc-default.css">
</head>

<body>

<div id="main">

    <h1 class="page-title">Source: index.js</h1>

    



    
    <section>
        <article>
            <pre class="prettyprint source linenums"><code>const OpenSCADFunction = require('./api/OpenSCADFunction');
const ThreeDModule = require('./api/ThreeDModule');
const TwoDModule = require('./api/TwoDModule');
const Types = require('./types/Types');

/**
 * @typedef {object} UnitTestSCAD This is the top level object exposed when requiring UnitTestSCAD into a NodeJS script.
 * @property {Function} Function Exposes the {@link Function} class for use. This should be used when testing an OpenSCAD function.
 * @property {ThreeDModule} ThreeDModule Exposes the {@link ThreeDModule} class for use. This should be used when testing an OpenSCAD module which produces a 3D model.
 * @property {TwoDModule} TwoDModule Exposes the {@link TwoDModule} class for use. This should be used when testing an OpenSCAD module which produces a 2D model.
 * @property {Types} Types Exposes the {@link Types} object for use. This should be used when performing assertions on a {@link Function}.
 */
module.exports = {
  Function: OpenSCADFunction,
  ThreeDModule,
  TwoDModule,
  Types
};</code></pre>
        </article>
    </section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="Function.html">Function</a></li><li><a href="ThreeDModule.html">ThreeDModule</a></li><li><a href="TwoDModule.html">TwoDModule</a></li></ul><h3><a href="global.html">Global</a></h3>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a>
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>