Page MenuHomeSealhub
Files F12661430

ResourceTypeField.html
No OneTemporary
Actions

ResourceTypeField.html
View Options

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<title>JSDoc: Class: ResourceTypeField</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: ResourceTypeField</h1>
<section>
<header>
<h2>
ResourceTypeField
</h2>
</header>
<article>
<div class="container-overview">
<dt>
<h2>Constructor</h2>
<h4 class="name" id="ResourceTypeField"><span class="type-signature"></span>new ResourceTypeField<span class="signature">(name, options)</span><span class="type-signature"></span></h4>
</dt>
<dd>
<div class="description">
A field in a resource type
</div>
<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>name</code></td>
<td class="type">
<span class="param-type">string</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>options</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="node_modules_prometheus-resource-type-field_resource-type-field.js.html">node_modules/prometheus-resource-type-field/resource-type-field.js</a>, <a href="node_modules_prometheus-resource-type-field_resource-type-field.js.html#line10">line 10</a>
</li></ul></dd>
</dl>
</dd>
</div>
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<h4 class="name" id="decodeValue"><span class="type-signature"></span>decodeValue<span class="signature">()</span><span class="type-signature"></span></h4>
</dt>
<dd>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="node_modules_prometheus-resource-type-field_resource-type-field.js.html">node_modules/prometheus-resource-type-field/resource-type-field.js</a>, <a href="node_modules_prometheus-resource-type-field_resource-type-field.js.html#line57">line 57</a>
</li></ul></dd>
<dt class="tag-todo">To Do:</dt>
<dd class="tag-todo">
<ul>
<li>Zaimplementować tę funkcję</li>
</ul>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="encodeValue"><span class="type-signature"></span>encodeValue<span class="signature">(value, as_hashmap)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
</dt>
<dd>
<div class="description">
Encodes a value for this field so it can be stored safey in database. Reverse of @link ResourceTypeField#decodeValue
</div>
<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>value</code></td>
<td class="type">
<span class="param-type">any</span>
</td>
<td class="description last"></td>
</tr>
<tr>
<td class="name"><code>as_hashmap</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="node_modules_prometheus-resource-type-field_resource-type-field.js.html">node_modules/prometheus-resource-type-field/resource-type-field.js</a>, <a href="node_modules_prometheus-resource-type-field_resource-type-field.js.html#line37">line 37</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
</dd>
<dt>
<h4 class="name" id="isProperValue"><span class="type-signature"></span>isProperValue<span class="signature">(value)</span><span class="type-signature"> &rarr; {Promise}</span></h4>
</dt>
<dd>
<div class="description">
Shorthand for ResourceTypeField.type.isProperValue
</div>
<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>value</code></td>
<td class="type">
<span class="param-type">object</span>
</td>
<td class="description last"></td>
</tr>
</tbody>
</table>
<dl class="details">
<dt class="tag-source">Source:</dt>
<dd class="tag-source"><ul class="dummy"><li>
<a href="node_modules_prometheus-resource-type-field_resource-type-field.js.html">node_modules/prometheus-resource-type-field/resource-type-field.js</a>, <a href="node_modules_prometheus-resource-type-field_resource-type-field.js.html#line26">line 26</a>
</li></ul></dd>
</dl>
<h5>Returns:</h5>
<dl>
<dt>
Type
</dt>
<dd>
<span class="param-type">Promise</span>
</dd>
</dl>
</dd>
</dl>
</article>
</section>
</div>
<nav>
<h2><a href="index.html">Home</a></h2><h3>Modules</h3><ul><li><a href="module-database-accessor.html">database-accessor</a></li><li><a href="module-field-type-manager.html">field-type-manager</a></li><li><a href="module-resource-type-manager.html">resource-type-manager</a></li></ul><h3>Classes</h3><ul><li><a href="AssociationInterface.html">AssociationInterface</a></li><li><a href="field-type-manager-Association.html">Association</a></li><li><a href="FieldType.html">FieldType</a></li><li><a href="Resource.html">Resource</a></li><li><a href="ResourceManager.html">ResourceManager</a></li><li><a href="ResourceType.html">ResourceType</a></li><li><a href="ResourceTypeField.html">ResourceTypeField</a></li></ul><h3>Global</h3><ul><li><a href="global.html#construct_resource_type">construct_resource_type</a></li></ul>
</nav>
<br clear="both">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.0-alpha11</a> on Mon Dec 08 2014 13:12:25 GMT+0100 (CET)
</footer>
<script> prettyPrint(); </script>
<script src="scripts/linenumber.js"> </script>
</body>
</html>

File Metadata

Mime Type
text/html
Expires
Fri, Nov 28, 15:46 (21 h, 30 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
1083434
Default Alt Text
ResourceTypeField.html (8 KB)

Event Timeline