express-mesh
Version:
A Gentics Mesh frontend for Express.
1,377 lines • 85.2 kB
HTML
<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>Mesh | ExpressMesh</title>
<meta name="description" content="">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script src="../assets/js/modernizr.js"></script>
</head>
<body>
<header>
<div class="tsd-page-toolbar">
<div class="container">
<div class="table-wrap">
<div class="table-cell" id="tsd-search" data-index="../assets/js/search.js" data-base="..">
<div class="field">
<label for="tsd-search-field" class="tsd-widget search no-caption">Search</label>
<input id="tsd-search-field" type="text" />
</div>
<ul class="results">
<li class="state loading">Preparing search index...</li>
<li class="state failure">The search index is not available</li>
</ul>
<a href="../index.html" class="title">ExpressMesh</a>
</div>
<div class="table-cell" id="tsd-widgets">
<div id="tsd-filter">
<a href="#" class="tsd-widget options no-caption" data-toggle="options">Options</a>
<div class="tsd-filter-group">
<div class="tsd-select" id="tsd-filter-visibility">
<span class="tsd-select-label">All</span>
<ul class="tsd-select-list">
<li data-value="public">Public</li>
<li data-value="protected">Public/Protected</li>
<li data-value="private" class="selected">All</li>
</ul>
</div>
<input type="checkbox" id="tsd-filter-inherited" checked />
<label class="tsd-widget" for="tsd-filter-inherited">Inherited</label>
<input type="checkbox" id="tsd-filter-externals" checked />
<label class="tsd-widget" for="tsd-filter-externals">Externals</label>
<input type="checkbox" id="tsd-filter-only-exported" />
<label class="tsd-widget" for="tsd-filter-only-exported">Only exported</label>
</div>
</div>
<a href="#" class="tsd-widget menu no-caption" data-toggle="menu">Menu</a>
</div>
</div>
</div>
</div>
<div class="tsd-page-title">
<div class="container">
<ul class="tsd-breadcrumb">
<li>
<a href="../globals.html">Globals</a>
</li>
<li>
<a href="../modules/_lib_mesh_.html">"lib/mesh"</a>
</li>
<li>
<a href="_lib_mesh_.mesh.html">Mesh</a>
</li>
</ul>
<h1>Class Mesh</h1>
</div>
</div>
</header>
<div class="container container-main">
<div class="row">
<div class="col-8 col-content">
<section class="tsd-panel tsd-comment">
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Main entry point for the frontend API. Use this class to power your express mesh server.</p>
</div>
<p>Usage:
import * as mesh from 'express-mesh';
var Mesh = new mesh.Mesh(new mesh.MeshConfig('Demo', 'public', 'languages'));
Mesh.server(app);</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="target">Mesh</span>
</li>
</ul>
</section>
<section class="tsd-panel-group tsd-index-group">
<h2>Index</h2>
<section class="tsd-panel tsd-index-panel">
<div class="tsd-index-content">
<section class="tsd-index-section ">
<h3>Constructors</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-constructor tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#constructor" class="tsd-kind-icon">constructor</a></li>
</ul>
</section>
<section class="tsd-index-section tsd-is-private tsd-is-private-protected">
<h3>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_lib_mesh_.mesh.html#app" class="tsd-kind-icon">app</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_lib_mesh_.mesh.html#config" class="tsd-kind-icon">config</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_lib_mesh_.mesh.html#meshclient" class="tsd-kind-icon">mesh<wbr>Client</a></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><a href="_lib_mesh_.mesh.html#renderer" class="tsd-kind-icon">renderer</a></li>
</ul>
</section>
<section class="tsd-index-section ">
<h3>Methods</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="_lib_mesh_.mesh.html#get" class="tsd-kind-icon">get</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="_lib_mesh_.mesh.html#getchildren" class="tsd-kind-icon">get<wbr>Children</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#getnavigationbypath" class="tsd-kind-icon">get<wbr>Navigation<wbr>ByPath</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#getnavigationbyuuid" class="tsd-kind-icon">get<wbr>Navigation<wbr>ByUUID</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="_lib_mesh_.mesh.html#getnode" class="tsd-kind-icon">get<wbr>Node</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_lib_mesh_.mesh.html#getrequesthandler" class="tsd-kind-icon">get<wbr>Request<wbr>Handler</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#gettagfamilies" class="tsd-kind-icon">get<wbr>Tag<wbr>Families</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#gettagsoftagfamily" class="tsd-kind-icon">get<wbr>Tags<wbr>OfTag<wbr>Family</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#login" class="tsd-kind-icon">login</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#logout" class="tsd-kind-icon">logout</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#registererrorhandler" class="tsd-kind-icon">register<wbr>Error<wbr>Handler</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><a href="_lib_mesh_.mesh.html#registermeshmiddleware" class="tsd-kind-icon">register<wbr>Mesh<wbr>Middleware</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="_lib_mesh_.mesh.html#registerschemahandler" class="tsd-kind-icon">register<wbr>Schema<wbr>Handler</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#registertemplatefilters" class="tsd-kind-icon">register<wbr>Template<wbr>Filters</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#registerviewhandler" class="tsd-kind-icon">register<wbr>View<wbr>Handler</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#rendernode" class="tsd-kind-icon">render<wbr>Node</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#renderview" class="tsd-kind-icon">render<wbr>View</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="_lib_mesh_.mesh.html#request" class="tsd-kind-icon">request</a></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter"><a href="_lib_mesh_.mesh.html#searchnodes" class="tsd-kind-icon">search<wbr>Nodes</a></li>
<li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_mesh_.mesh.html#server" class="tsd-kind-icon">server</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Constructors</h2>
<section class="tsd-panel tsd-member tsd-kind-constructor tsd-parent-kind-class">
<a name="constructor" class="tsd-anchor"></a>
<h3>constructor</h3>
<ul class="tsd-signatures tsd-kind-constructor tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">new <wbr>Mesh<span class="tsd-signature-symbol">(</span>app<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">express.Express</span>, config<span class="tsd-signature-symbol">: </span><a href="_lib_config_.meshconfig.html" class="tsd-signature-type">MeshConfig</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><a href="_lib_mesh_.mesh.html" class="tsd-signature-type">Mesh</a></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L233">lib/mesh.ts:233</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Constructor for the main frontend API entry point.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>app: <span class="tsd-signature-type">express.Express</span></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Express app.</p>
</div>
</div>
</li>
<li>
<h5>config: <a href="_lib_config_.meshconfig.html" class="tsd-signature-type">MeshConfig</a></h5>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Configuration for the mesh server.</p>
</div>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <a href="_lib_mesh_.mesh.html" class="tsd-signature-type">Mesh</a></h4>
</li>
</ul>
</section>
</section>
<section class="tsd-panel-group tsd-member-group tsd-is-private tsd-is-private-protected">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="app" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> app</h3>
<div class="tsd-signature tsd-kind-icon">app<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">express.Express</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L240">lib/mesh.ts:240</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Express app.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="config" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> config</h3>
<div class="tsd-signature tsd-kind-icon">config<span class="tsd-signature-symbol">:</span> <a href="_lib_config_.meshconfig.html" class="tsd-signature-type">MeshConfig</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L240">lib/mesh.ts:240</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Configuration for the mesh server.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="meshclient" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> mesh<wbr>Client</h3>
<div class="tsd-signature tsd-kind-icon">mesh<wbr>Client<span class="tsd-signature-symbol">:</span> <a href="_lib_meshrestclient_.meshrestclient.html" class="tsd-signature-type">MeshRestClient</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L232">lib/mesh.ts:232</a></li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a name="renderer" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> renderer</h3>
<div class="tsd-signature tsd-kind-icon">renderer<span class="tsd-signature-symbol">:</span> <a href="_lib_meshrenderer_.meshrenderer.html" class="tsd-signature-type">MeshRenderer</a></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L233">lib/mesh.ts:233</a></li>
</ul>
</aside>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Methods</h2>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="get" class="tsd-anchor"></a>
<h3>get</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">get<T><span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">?: </span><a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L440">lib/mesh.ts:440</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Make a GET request to the mesh backend.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The Mesh Request</p>
</div>
</li>
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The url you want to GET</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>Query params for your request.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled once the request has been completed
and will fail if the request fails.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="getchildren" class="tsd-anchor"></a>
<h3>get<wbr>Children</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">get<wbr>Children<T><span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, uuid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">?: </span><a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnodelistresponse.html" class="tsd-signature-type">IMeshNodeListResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnode.html" class="tsd-signature-type">IMeshNode</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L363">lib/mesh.ts:363</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Load all child nodes of a specified node.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
<li>
<h5>uuid: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The specified node, which children should be loaded.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>QueryParams to specify the language and other options.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnodelistresponse.html" class="tsd-signature-type">IMeshNodeListResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnode.html" class="tsd-signature-type">IMeshNode</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled once the children have been loaded and will be rejected
if loading the children fails.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getnavigationbypath" class="tsd-anchor"></a>
<h3>get<wbr>Navigation<wbr>ByPath</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Navigation<wbr>ByPath<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, path<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnav.html" class="tsd-signature-type">IMeshNav</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L392">lib/mesh.ts:392</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Load a navigation object by its path. e.g. / for the root navigation.
You can only load navigation objects for container nodes.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
<li>
<h5>path: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The path for which the navigation object should be loaded.</p>
</div>
</li>
<li>
<h5>params: <a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>QueryParams to specify the language, navigation depth, includeAll and other options.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnav.html" class="tsd-signature-type">IMeshNav</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled once the navigation object
has been loaded and will be rejected if loading of the navigation object fails.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="getnavigationbyuuid" class="tsd-anchor"></a>
<h3>get<wbr>Navigation<wbr>ByUUID</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Navigation<wbr>ByUUID<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, uuid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">: </span><a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnav.html" class="tsd-signature-type">IMeshNav</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L405">lib/mesh.ts:405</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Load a navigation object by its uuid.
You can only load navigation objects for container nodes.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
<li>
<h5>uuid: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The uuid of the root node of the navigation tree you want to load.</p>
</div>
</li>
<li>
<h5>params: <a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>QueryParams to specify the language, navigation depth, includeAll and other options.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnav.html" class="tsd-signature-type">IMeshNav</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled once the navigation object
has been loaded and will be rejected if loading of the navigation object fails.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="getnode" class="tsd-anchor"></a>
<h3>get<wbr>Node</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">get<wbr>Node<T><span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, uuid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">?: </span><a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnode.html" class="tsd-signature-type">IMeshNode</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L377">lib/mesh.ts:377</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Load a Mesh node with the specified uuid.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
<li>
<h5>uuid: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The uuid of the node that should be loaded.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>QueryParams to specify the language and other options.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnode.html" class="tsd-signature-type">IMeshNode</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled once the Mesh node is loaded and will be rejected
if loading of the Mesh node fails.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="getrequesthandler" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> get<wbr>Request<wbr>Handler</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">get<wbr>Request<wbr>Handler<span class="tsd-signature-symbol">(</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">function</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L462">lib/mesh.ts:462</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Private method that constructs the quest handler, that will serve the Mesh content from webroot.</p>
</div>
</div>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">function</span></h4>
<ul class="tsd-parameters">
<li class="tsd-parameter-siganture">
<ul class="tsd-signatures tsd-kind-type-literal tsd-is-not-exported">
<li class="tsd-signature tsd-kind-icon"><span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">express.Request</span>, res<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">express.Response</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <span class="tsd-signature-type">express.Request</span></h5>
</li>
<li>
<h5>res: <span class="tsd-signature-type">express.Response</span></h5>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettagfamilies" class="tsd-anchor"></a>
<h3>get<wbr>Tag<wbr>Families</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Tag<wbr>Families<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, params<span class="tsd-signature-symbol">?: </span><a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnodelistresponse.html" class="tsd-signature-type">IMeshNodeListResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshtagfamily.html" class="tsd-signature-type">IMeshTagFamily</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L416">lib/mesh.ts:416</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Load the tag families of the current project.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>Query params to specify pagination.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnodelistresponse.html" class="tsd-signature-type">IMeshNodeListResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshtagfamily.html" class="tsd-signature-type">IMeshTagFamily</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled once
the tag families have been loaded and will be rejected if loading of the tag families fails.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="gettagsoftagfamily" class="tsd-anchor"></a>
<h3>get<wbr>Tags<wbr>OfTag<wbr>Family</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">get<wbr>Tags<wbr>OfTag<wbr>Family<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, uuid<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">?: </span><a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnodelistresponse.html" class="tsd-signature-type">IMeshNodeListResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshtag.html" class="tsd-signature-type">IMeshTag</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L428">lib/mesh.ts:428</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Load the tags that are contained in a tag family.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
<li>
<h5>uuid: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The uuid of the tag family.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>Query params to specify pagination.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnodelistresponse.html" class="tsd-signature-type">IMeshNodeListResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshtag.html" class="tsd-signature-type">IMeshTag</a><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled once
the tags have been loaded and will fail if loading of the tags fail.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="login" class="tsd-anchor"></a>
<h3>login</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">login<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, username<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, password<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L316">lib/mesh.ts:316</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Login to Gentics Mesh with the provided user. All subsequent requests with the same session
will use the provided credentials for requests to Mesh.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
<li>
<h5>username: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Login</p>
</div>
</li>
<li>
<h5>password: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Password</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled as soon es the login completes and will
be rejected if the login fails.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="logout" class="tsd-anchor"></a>
<h3>logout</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">logout<span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L333">lib/mesh.ts:333</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Logout from Gentics Mesh. All subsequent requests with the same session will use the default
user that has been configured in the MeshConfig for requests to Mesh.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">boolean</span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled as soon as the logout completes and will
be rejected if the logout fails.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="registererrorhandler" class="tsd-anchor"></a>
<h3>register<wbr>Error<wbr>Handler</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">register<wbr>Error<wbr>Handler<span class="tsd-signature-symbol">(</span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, handler<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_meshhandlerstore_.imesherrorhandler.html" class="tsd-signature-type">IMeshErrorHandler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L276">lib/mesh.ts:276</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register a custom error handler.
A error handler will be executed if an error with the status it has been registered for
occurs.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>status: <span class="tsd-signature-type">number</span></h5>
<div class="tsd-comment tsd-typography">
<p>The status the handler should be registered for</p>
</div>
</li>
<li>
<h5>handler: <a href="../interfaces/_lib_meshhandlerstore_.imesherrorhandler.html" class="tsd-signature-type">IMeshErrorHandler</a></h5>
<div class="tsd-comment tsd-typography">
<p>The handler that should be registered</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a name="registermeshmiddleware" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagPrivate">Private</span> register<wbr>Mesh<wbr>Middleware</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-is-private">
<li class="tsd-signature tsd-kind-icon">register<wbr>Mesh<wbr>Middleware<span class="tsd-signature-symbol">(</span>app<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">express.Express</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L489">lib/mesh.ts:489</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Private method that will register the mesh middleware in the Express app.
This middleware will enrich the mesh request with the configuration and the
active language.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>app: <span class="tsd-signature-type">express.Express</span></h5>
<div class="tsd-comment tsd-typography">
<p>The Express app.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="registerschemahandler" class="tsd-anchor"></a>
<h3>register<wbr>Schema<wbr>Handler</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">register<wbr>Schema<wbr>Handler<T><span class="tsd-signature-symbol">(</span>schema<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, handler<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_meshhandlerstore_.imeshschemahandler.html" class="tsd-signature-type">IMeshSchemaHandler</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L254">lib/mesh.ts:254</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register a custom schema handler.
A registered schema handler will be executed before a node with the schema it has been
registered for will be rendered. This can be used to fetch additional information and
perform operations on the data provided by Mesh.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>schema: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>Schema the handler should be registered for</p>
</div>
</li>
<li>
<h5>handler: <a href="../interfaces/_lib_meshhandlerstore_.imeshschemahandler.html" class="tsd-signature-type">IMeshSchemaHandler</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<p>The handler that should be registered</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="registertemplatefilters" class="tsd-anchor"></a>
<h3>register<wbr>Template<wbr>Filters</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">register<wbr>Template<wbr>Filters<span class="tsd-signature-symbol">(</span>engine<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</span>, registerfunction<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_lib_meshtemplatefilters_.ifilterregisterfunction.html" class="tsd-signature-type">IFilterRegisterFunction</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L514">lib/mesh.ts:514</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register default template filters.
Out of the box we support registering filters with swig and handlebars. If you have a different template engine
please pass a register function to register the filters with your template engine. This function will then be called
for each of the mesh filters.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>engine: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Your template engine.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> registerfunction: <a href="../interfaces/_lib_meshtemplatefilters_.ifilterregisterfunction.html" class="tsd-signature-type">IFilterRegisterFunction</a></h5>
<div class="tsd-comment tsd-typography">
<p>register function that will be called for each of the mesh filters.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="registerviewhandler" class="tsd-anchor"></a>
<h3>register<wbr>View<wbr>Handler</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">register<wbr>View<wbr>Handler<span class="tsd-signature-symbol">(</span>handler<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_meshhandlerstore_.imeshviewhandler.html" class="tsd-signature-type">IMeshViewHandler</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L265">lib/mesh.ts:265</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Register a custom view handler.
A view handler will be executed every time before a view is being rendered by the Mesh
frontend. This can be used to fetch additional information and perform operations on the
data provided by Mesh.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>handler: <a href="../interfaces/_lib_meshhandlerstore_.imeshviewhandler.html" class="tsd-signature-type">IMeshViewHandler</a></h5>
<div class="tsd-comment tsd-typography">
<p>The handler that should be registered</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="rendernode" class="tsd-anchor"></a>
<h3>render<wbr>Node</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">render<wbr>Node<span class="tsd-signature-symbol">(</span>node<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshnode.html" class="tsd-signature-type">IMeshNode</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span>, req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, res<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshresponse.html" class="tsd-signature-type">IMeshResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L289">lib/mesh.ts:289</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Render a Mesh node.
This function will render the provided node with the view that is named after the node's schema.
If the view with this name is not available, the default view will be rendered.
All registered handlers that apply for this function will be executed.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>node: <a href="../interfaces/_lib_mesh_.imeshnode.html" class="tsd-signature-type">IMeshNode</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">></span></h5>
<div class="tsd-comment tsd-typography">
<p>Mesh node that should be rendered.</p>
</div>
</li>
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
<li>
<h5>res: <a href="../interfaces/_lib_mesh_.imeshresponse.html" class="tsd-signature-type">IMeshResponse</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh response / Express response.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="renderview" class="tsd-anchor"></a>
<h3>render<wbr>View</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">render<wbr>View<span class="tsd-signature-symbol">(</span>view<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, renderdata<span class="tsd-signature-symbol">: </span><a href="_lib_meshrenderer_.renderdata.html" class="tsd-signature-type">RenderData</a>, req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, res<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshresponse.html" class="tsd-signature-type">IMeshResponse</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L303">lib/mesh.ts:303</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Render a view.
This function will render the provided view.
If the view with this name is not available, the default view will be rendered.
All registered handlers that apply for this function will be executed.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>view: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>name of the view that should be rendered.</p>
</div>
</li>
<li>
<h5>renderdata: <a href="_lib_meshrenderer_.renderdata.html" class="tsd-signature-type">RenderData</a></h5>
<div class="tsd-comment tsd-typography">
<p>Data that should be passed to the view.</p>
</div>
</li>
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
<li>
<h5>res: <a href="../interfaces/_lib_mesh_.imeshresponse.html" class="tsd-signature-type">IMeshResponse</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh response / Express response.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="request" class="tsd-anchor"></a>
<h3>request</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">request<T><span class="tsd-signature-symbol">(</span>method<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, url<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">string</span>, params<span class="tsd-signature-symbol">?: </span><a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a>, data<span class="tsd-signature-symbol">?: </span><span class="tsd-signature-type">any</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L454">lib/mesh.ts:454</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Make a request to the mesh backend.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>method: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The request method (GET/POST/PUT/DELETE/...)</p>
</div>
</li>
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The Mesh Request</p>
</div>
</li>
<li>
<h5>url: <span class="tsd-signature-type">string</span></h5>
<div class="tsd-comment tsd-typography">
<p>The url you want to GET</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <a href="_lib_mesh_.meshqueryparams.html" class="tsd-signature-type">MeshQueryParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>Query params for your request.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> data: <span class="tsd-signature-type">any</span></h5>
<div class="tsd-comment tsd-typography">
<p>Data you want to send with the request (PUT/POST)</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="_lib_meshrestclient_.meshrestresponse.html" class="tsd-signature-type">MeshRestResponse</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled once the request has been completed
and will fail if the request fails.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a name="searchnodes" class="tsd-anchor"></a>
<h3>search<wbr>Nodes</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<li class="tsd-signature tsd-kind-icon">search<wbr>Nodes<T><span class="tsd-signature-symbol">(</span>req<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a>, query<span class="tsd-signature-symbol">: </span><a href="../interfaces/_lib_mesh_.imeshsearchquery.html" class="tsd-signature-type">IMeshSearchQuery</a>, params<span class="tsd-signature-symbol">?: </span><a href="../interfaces/_lib_mesh_.imeshnodelistqueryparams.html" class="tsd-signature-type">IMeshNodeListQueryParams</a><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnodelistresponse.html" class="tsd-signature-type">IMeshNodeListResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnode.html" class="tsd-signature-type">IMeshNode</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L349">lib/mesh.ts:349</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Perform a search for Mesh Nodes.</p>
</div>
</div>
<h4 class="tsd-type-parameters-title">Type parameters</h4>
<ul class="tsd-type-parameters">
<li>
<h4>T</h4>
</li>
</ul>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>req: <a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-signature-type">IMeshRequest</a></h5>
<div class="tsd-comment tsd-typography">
<p>The mesh request / Express request.</p>
</div>
</li>
<li>
<h5>query: <a href="../interfaces/_lib_mesh_.imeshsearchquery.html" class="tsd-signature-type">IMeshSearchQuery</a></h5>
<div class="tsd-comment tsd-typography">
<p>The elastic search query object.</p>
</div>
</li>
<li>
<h5><span class="tsd-flag ts-flagOptional">Optional</span> params: <a href="../interfaces/_lib_mesh_.imeshnodelistqueryparams.html" class="tsd-signature-type">IMeshNodeListQueryParams</a></h5>
<div class="tsd-comment tsd-typography">
<p>NodeListParams to implement pagination.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">Promise</span><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnodelistresponse.html" class="tsd-signature-type">IMeshNodeListResponse</a><span class="tsd-signature-symbol"><</span><a href="../interfaces/_lib_mesh_.imeshnode.html" class="tsd-signature-type">IMeshNode</a><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">T</span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span><span class="tsd-signature-symbol">></span></h4>
<p>A promise that will be fulfilled once the search request complets and will be rejected
if the search fails.</p>
</li>
</ul>
</section>
<section class="tsd-panel tsd-member tsd-kind-method tsd-parent-kind-class">
<a name="server" class="tsd-anchor"></a>
<h3>server</h3>
<ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class">
<li class="tsd-signature tsd-kind-icon">server<span class="tsd-signature-symbol">(</span>app<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">express.Express</span><span class="tsd-signature-symbol">)</span><span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">void</span></li>
</ul>
<ul class="tsd-descriptions">
<li class="tsd-description">
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/gentics/express-mesh/blob/master/src/lib/mesh.ts#L523">lib/mesh.ts:523</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>Initialize the Mesh server. Call this method after you added your own request handlers to the Express app,
as this method will attach a * handler to catch all requests that have not been handled by another handler.</p>
</div>
</div>
<h4 class="tsd-parameters-title">Parameters</h4>
<ul class="tsd-parameters">
<li>
<h5>app: <span class="tsd-signature-type">express.Express</span></h5>
<div class="tsd-comment tsd-typography">
<p>The Express app.</p>
</div>
</li>
</ul>
<h4 class="tsd-returns-title">Returns <span class="tsd-signature-type">void</span></h4>
</li>
</ul>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class="globals ">
<a href="../globals.html"><em>Globals</em></a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_index_.html">"index"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_lib_config_.html">"lib/config"</a>
</li>
<li class="current tsd-kind-external-module">
<a href="../modules/_lib_mesh_.html">"lib/mesh"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_lib_meshhandlerstore_.html">"lib/mesh<wbr>Handler<wbr>Store"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_lib_meshlanguages_.html">"lib/mesh<wbr>Languages"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_lib_meshrenderer_.html">"lib/mesh<wbr>Renderer"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_lib_meshrestclient_.html">"lib/mesh<wbr>Rest<wbr>Client"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_lib_meshtemplatefilters_.html">"lib/mesh<wbr>Template<wbr>Filters"</a>
</li>
<li class=" tsd-kind-external-module">
<a href="../modules/_lib_meshutil_.html">"lib/mesh<wbr>Util"</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
<li class=" tsd-kind-enum tsd-parent-kind-external-module">
<a href="../enums/_lib_mesh_.meshpermission.html" class="tsd-kind-icon">Mesh<wbr>Permission</a>
</li>
</ul>
<ul class="current">
<li class="current tsd-kind-class tsd-parent-kind-external-module">
<a href="_lib_mesh_.mesh.html" class="tsd-kind-icon">Mesh</a>
<ul>
<li class=" tsd-kind-constructor tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#constructor" class="tsd-kind-icon">constructor</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_lib_mesh_.mesh.html#app" class="tsd-kind-icon">app</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_lib_mesh_.mesh.html#config" class="tsd-kind-icon">config</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_lib_mesh_.mesh.html#meshclient" class="tsd-kind-icon">mesh<wbr>Client</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-class tsd-is-private">
<a href="_lib_mesh_.mesh.html#renderer" class="tsd-kind-icon">renderer</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="_lib_mesh_.mesh.html#get" class="tsd-kind-icon">get</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="_lib_mesh_.mesh.html#getchildren" class="tsd-kind-icon">get<wbr>Children</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#getnavigationbypath" class="tsd-kind-icon">get<wbr>Navigation<wbr>ByPath</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#getnavigationbyuuid" class="tsd-kind-icon">get<wbr>Navigation<wbr>ByUUID</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="_lib_mesh_.mesh.html#getnode" class="tsd-kind-icon">get<wbr>Node</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_lib_mesh_.mesh.html#getrequesthandler" class="tsd-kind-icon">get<wbr>Request<wbr>Handler</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#gettagfamilies" class="tsd-kind-icon">get<wbr>Tag<wbr>Families</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#gettagsoftagfamily" class="tsd-kind-icon">get<wbr>Tags<wbr>OfTag<wbr>Family</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#login" class="tsd-kind-icon">login</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#logout" class="tsd-kind-icon">logout</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#registererrorhandler" class="tsd-kind-icon">register<wbr>Error<wbr>Handler</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-is-private">
<a href="_lib_mesh_.mesh.html#registermeshmiddleware" class="tsd-kind-icon">register<wbr>Mesh<wbr>Middleware</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="_lib_mesh_.mesh.html#registerschemahandler" class="tsd-kind-icon">register<wbr>Schema<wbr>Handler</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#registertemplatefilters" class="tsd-kind-icon">register<wbr>Template<wbr>Filters</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#registerviewhandler" class="tsd-kind-icon">register<wbr>View<wbr>Handler</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#rendernode" class="tsd-kind-icon">render<wbr>Node</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#renderview" class="tsd-kind-icon">render<wbr>View</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="_lib_mesh_.mesh.html#request" class="tsd-kind-icon">request</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class tsd-has-type-parameter">
<a href="_lib_mesh_.mesh.html#searchnodes" class="tsd-kind-icon">search<wbr>Nodes</a>
</li>
<li class=" tsd-kind-method tsd-parent-kind-class">
<a href="_lib_mesh_.mesh.html#server" class="tsd-kind-icon">server</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-class tsd-parent-kind-external-module">
<a href="_lib_mesh_.meshqueryparams.html" class="tsd-kind-icon">Mesh<wbr>Query<wbr>Params</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../interfaces/_lib_mesh_.binarynode.html" class="tsd-kind-icon">Binary<wbr>Node</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshmetainfo.html" class="tsd-kind-icon">IMesh<wbr>Meta<wbr>Info</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshnav.html" class="tsd-kind-icon">IMesh<wbr>Nav</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshnavelement.html" class="tsd-kind-icon">IMesh<wbr>Nav<wbr>Element</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../interfaces/_lib_mesh_.imeshnode.html" class="tsd-kind-icon">IMesh<wbr>Node</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshnodelistqueryparams.html" class="tsd-kind-icon">IMesh<wbr>Node<wbr>List<wbr>Query<wbr>Params</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter">
<a href="../interfaces/_lib_mesh_.imeshnodelistresponse.html" class="tsd-kind-icon">IMesh<wbr>Node<wbr>List<wbr>Response</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshnoderef.html" class="tsd-kind-icon">IMesh<wbr>Node<wbr>Ref</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshobject.html" class="tsd-kind-icon">IMesh<wbr>Object</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshref.html" class="tsd-kind-icon">IMesh<wbr>Ref</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshrequest.html" class="tsd-kind-icon">IMesh<wbr>Request</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshresponse.html" class="tsd-kind-icon">IMesh<wbr>Response</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshsearchquery.html" class="tsd-kind-icon">IMesh<wbr>Search<wbr>Query</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshtag.html" class="tsd-kind-icon">IMesh<wbr>Tag</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshtagfamily.html" class="tsd-kind-icon">IMesh<wbr>Tag<wbr>Family</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.imeshtags.html" class="tsd-kind-icon">IMesh<wbr>Tags</a>
</li>
<li class=" tsd-kind-interface tsd-parent-kind-external-module">
<a href="../interfaces/_lib_mesh_.itagfields.html" class="tsd-kind-icon">ITag<wbr>Fields</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer class="with-border-bottom">
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<li class="tsd-kind-module"><span class="tsd-kind-icon">Module</span></li>
<li class="tsd-kind-object-literal"><span class="tsd-kind-icon">Object literal</span></li>
<li class="tsd-kind-variable"><span class="tsd-kind-icon">Variable</span></li>
<li class="tsd-kind-function"><span class="tsd-kind-icon">Function</span></li>
<li class="tsd-kind-function tsd-has-type-parameter"><span class="tsd-kind-icon">Function with type parameter</span></li>
<li class="tsd-kind-index-signature"><span class="tsd-kind-icon">Index signature</span></li>
<li class="tsd-kind-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-enum"><span class="tsd-kind-icon">Enumeration</span></li>
<li class="tsd-kind-enum-member"><span class="tsd-kind-icon">Enumeration member</span></li>
<li class="tsd-kind-property tsd-parent-kind-enum"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-enum"><span class="tsd-kind-icon">Method</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-interface"><span class="tsd-kind-icon">Interface</span></li>
<li class="tsd-kind-interface tsd-has-type-parameter"><span class="tsd-kind-icon">Interface with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-interface"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-interface"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-interface"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-class"><span class="tsd-kind-icon">Class</span></li>
<li class="tsd-kind-class tsd-has-type-parameter"><span class="tsd-kind-icon">Class with type parameter</span></li>
<li class="tsd-kind-constructor tsd-parent-kind-class"><span class="tsd-kind-icon">Constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class"><span class="tsd-kind-icon">Property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class"><span class="tsd-kind-icon">Method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class"><span class="tsd-kind-icon">Accessor</span></li>
<li class="tsd-kind-index-signature tsd-parent-kind-class"><span class="tsd-kind-icon">Index signature</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-constructor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited constructor</span></li>
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-inherited"><span class="tsd-kind-icon">Inherited accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-protected"><span class="tsd-kind-icon">Protected accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private property</span></li>
<li class="tsd-kind-method tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private method</span></li>
<li class="tsd-kind-accessor tsd-parent-kind-class tsd-is-private"><span class="tsd-kind-icon">Private accessor</span></li>
</ul>
<ul class="tsd-legend">
<li class="tsd-kind-property tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static property</span></li>
<li class="tsd-kind-call-signature tsd-parent-kind-class tsd-is-static"><span class="tsd-kind-icon">Static method</span></li>
</ul>
</div>
</div>
</footer>
<div class="container tsd-generator">
<p>Generated using <a href="http://typedoc.io" target="_blank">TypeDoc</a></p>
</div>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
<script>if (location.protocol == 'file:') document.write('<script src="../assets/js/search.js"><' + '/script>');</script>
</body>
</html>