models_PathItem.js.html #1 

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="utf-8">
    <title>JSDoc: Source: models/PathItem.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: models/PathItem.js</h1>

    



    
    <section>
        <article>
            <pre class="prettyprint source linenums"><code>
var Depot = require('./Depot');
var Dir = require('./Dir');
var File = require('./File');

require('../polyfill');

function toItem(obj) {
  if (obj['Dir']) {
    return new Dir(obj);
  } else if (obj['DepotFile']) {
    return new File(obj);
  } else if (obj['Depot']) {
    return new Depot(obj);
  }
}

/**
 *
 * @static
 * @type {{create: Function}}
 */
var PathItem = {

  /**
   *
   * @param items
   * @name PathItem.create
   */
  create: function(items) {
    items.map(function(x) { toItem(x); });
  }
};

module.exports = PathItem;
</code></pre>
        </article>
    </section>




</div>

<nav>
    <h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="HelixWebServicesClient.html">HelixWebServicesClient</a></li><li><a href="models.Depot.html">Depot</a></li><li><a href="models.File.html">File</a></li></ul><h3>Mixins</h3><ul><li><a href="Node.html">Node</a></li></ul><h3>Global</h3><ul><li><a href="global.html#PathItem">PathItem</a></li></ul>
</nav>

<br class="clear">

<footer>
    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.4.0-dev</a> on Mon Jun 22 2015 15:12:49 GMT-0700 (PDT)
</footer>

<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>
# Change User Description Committed
#1 15741 ptomiak Branch HWS for my use.
//guest/perforce_software/helix-web-services/main/build/doc/helix_web_services_client_js/models_PathItem.js.html
#1 14108 tjuricek Added models for handling Perforce server depot listing and traversal.

This is not complete, however, the models are a start to making it easy to generate a tree control. (Most tree controls in the wild assume you know the tree structure from the start, which is not true in our case.) The tricky bit is making it easy to build the tree out given that you're visiting only one directory at a time.