@flexvertex/flexvertex-driver
Version:
The official FlexVertex Node.js driver
825 lines (169 loc) • 7.75 kB
HTML
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: FlexCargo</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">Class: FlexCargo</h1>
<section>
<header>
<h2><span class="attribs"><span class="type-signature"></span></span>FlexCargo</h2>
<div class="class-description">Represents the returned user 'cargo' from a Voyager execution.
A FlexCargo may have user-created properties as well as either a <a href="FlexJourney.html">FlexJourney</a> or a <a href="FlexResultSet.html">FlexResultSet</a>.</div>
</header>
<article>
<div class="container-overview">
<dl class="details">
</dl>
</div>
<h3 class="subsection-title">Classes</h3>
<dl>
<dt><a href="FlexCargo.html">FlexCargo</a></dt>
<dd></dd>
</dl>
<h3 class="subsection-title">Members</h3>
<h4 class="name" id="journey"><span class="type-signature"></span>journey<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>journey</code></td>
<td class="type">
<span class="param-type"><a href="FlexJourney.html">FlexJourney</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h4 class="name" id="resultSet"><span class="type-signature"></span>resultSet<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>resultSet</code></td>
<td class="type">
<span class="param-type"><a href="FlexResultSet.html">FlexResultSet</a></span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h4 class="name" id="userProperties"><span class="type-signature"></span>userProperties<span class="type-signature"></span></h4>
<h5 class="subsection-title">Properties:</h5>
<table class="props">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>userProperties</code></td>
<td class="type">
<span class="param-type">Object</span>
</td>
<td class="description last">Returns this FlexCargo's user properties</td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h3 class="subsection-title">Methods</h3>
<h4 class="name" id="getUserProperty"><span class="type-signature"></span>getUserProperty<span class="signature">(key<span class="signature-attributes">non-null</span>)</span><span class="type-signature"></span></h4>
<h5>Parameters:</h5>
<table class="params">
<thead>
<tr>
<th>Name</th>
<th>Type</th>
<th class="last">Description</th>
</tr>
</thead>
<tbody>
<tr>
<td class="name"><code>key</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
A user property named key if it exists
</div>
<h4 class="name" id="hasJourney"><span class="type-signature"></span>hasJourney<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if this FlexCargo contains a <a href="FlexJourney.html">FlexJourney</a>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
<h4 class="name" id="hasResultSet"><span class="type-signature"></span>hasResultSet<span class="signature">()</span><span class="type-signature"> → {boolean}</span></h4>
<dl class="details">
</dl>
<h5>Returns:</h5>
<div class="param-desc">
True if this FlexCargo contains a <a href="FlexResultSet.html">FlexResultSet</a>
</div>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">boolean</span>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Classes</h3><ul><li><a href="FlexCargo.html">FlexCargo</a></li><li><a href="FlexCommons.html">FlexCommons</a></li><li><a href="FlexConnection.html">FlexConnection</a></li><li><a href="FlexJourney.html">FlexJourney</a></li><li><a href="FlexObject.html">FlexObject</a></li><li><a href="FlexResultSet.html">FlexResultSet</a></li><li><a href="FlexSchema.html">FlexSchema</a></li><li><a href="FlexSegment.html">FlexSegment</a></li><li><a href="FlexSession.html">FlexSession</a></li><li><a href="FlexVertex.html">FlexVertex</a></li></ul>
</nav>
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc/jsdoc">JSDoc 4.0.4</a> on Sun Feb 23 2025 20:39:15 GMT-0700 (GMT-07:00)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>