angular-resource-url-type-factory
Version:
A factory used to build ui-router URL types that fetch data from RESTful APIs.
1 lines • 5.41 kB
HTML
<html>
<head>
<meta charset="utf-8">
<title>JSDoc: ResourceUrlTypeFactoryServiceProvider</title>
<link href="css/prettify-tomorrow.css" type="text/css" rel="stylesheet">
<link href="css/site.css" type="text/css" rel="stylesheet">
</head>
<body ng-app="">
<nav id="toc">
<input placeholder="Filter" id="filter-input" class="col12 block field" type="text">
<div class="nav-wrapper">
<h2><a href="index.html">Index</a></h2>
<ul class="module">
<!-- undefined -->
<h2 class="module">
<a chref="" ng-click="moduleundefined = !moduleundefined">
module: undefined
</a>
<i ng-cloak="" ng-show="moduleundefined">+</i>
</h2>
<li id="undefined" ng-hide="moduleundefined">
<ul class="group">
<h2>
<a href="" ng-click="undefinedfactory = !undefinedfactory">
factory
</a>
<i ng-cloak="" ng-show="undefinedfactory">+</i>
</h2>
<ul ng-hide="undefinedfactory">
<li>
<a href="ResourceUrlTypeFactoryService.html">ResourceUrlTypeFactoryService</a>
</li>
</ul>
</ul><ul class="group">
<h2>
<a href="" ng-click="undefinedprovider = !undefinedprovider">
provider
</a>
<i ng-cloak="" ng-show="undefinedprovider">+</i>
</h2>
<ul ng-hide="undefinedprovider">
<li>
<a href="ResourceUrlTypeFactoryServiceProvider.html">ResourceUrlTypeFactoryServiceProvider</a>
</li>
</ul>
</ul>
</li>
</ul>
</div>
</nav>
<div id="content" class="page-wrap">
<h3 style="float:right; color:#ccc">
Angular provider
</h3>
<h1 class="title">
ResourceUrlTypeFactoryServiceProvider
<a class="name-link signature-attributes" href="source/ResourceUrlTypeFactoryServiceProvider.html#line27">source</a>
</h1>
<div id="main" class="big-container">
<!-- source code html -->
<!-- index.html -->
<!-- class files -->
<div>
<div><div class="container-overview">
<ul class="chips">
</ul>
<div class="clearfix"></div>
<div class="description">
<h4>Description</h4>
<p>Provider for the ResourceUrlTypeFactoryService</p>
</div>
<div class="details"></div>
</div>
<div class="functions">
<h3 class="subsection-title">Methods</h3>
<dl>
<dt>
<a href="source/ResourceUrlTypeFactoryServiceProvider.html#line54" class="name-link" id="provider.registerType">
<h4 class="name">
provider.registerType
<span class="signature">(typeName, pattern, pkAttr, fetchFn)</span>
</h4>
</a>
</dt>
<dd>
<div class="description">
<span>
<p>Construct a type definition for a REST ui-router type</p>
</span>
</div>
<div>
<h4>Parameters</h4>
<table class="params">
<thead>
<tr><th>Name</th><th>Type</th><th class="last">Description</th></tr>
</thead>
<tbody>
<tr>
<td class="name">typeName</td>
<td class="type"><span class="param-type">
String
</span></td>
<td class="description last">
<span>
<p>Name for the type</p>
</span>
</td>
</tr><tr>
<td class="name">pattern</td>
<td class="type"><span class="param-type">
<a href="RegExp.html">RegExp</a>
</span></td>
<td class="description last">
<span>
<p>Pattern to match for</p>
</span>
</td>
</tr><tr>
<td class="name">pkAttr</td>
<td class="type"><span class="param-type">
String
</span></td>
<td class="description last">
<span>
<p>Name of the PK attribute</p>
</span>
</td>
</tr><tr>
<td class="name">fetchFn</td>
<td class="type"><span class="param-type">
Function
</span></td>
<td class="description last">
<span>
<p>Function to fetch the object from REST API (supports injection)</p>
</span>
</td>
</tr>
</tbody>
</table>
</div>
</dd>
</dl>
</div></div>
</div>
</div>
<footer style="clear:both">
Documentation generated by
<a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.3.2</a>
using
<a href="https://github.com/allenhwkim/angular-jsdoc">Angular-JSDoc template</a>
</footer>
</div>
<script src="js/prettify.js"></script>
<script src="js/angular.min.js"></script>
<script src="js/site.js"></script>
<!--%= prettyJson %-->
<script>
prettyPrint();
var lineNo = window.location.hash.match(/#line([0-9]+)$/);
lineNo && document.querySelector("ol li:nth-child("+(lineNo[1])+")").scrollIntoView();
</script>
</body>
</html>