express-mesh

<!doctype html> <html class="default no-js"> <head> <meta charset="utf-8"> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <title>ErrorHandlerStore | 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_meshhandlerstore_.html">"lib/meshHandlerStore"</a> </li> <li> <a href="_lib_meshhandlerstore_.errorhandlerstore.html">ErrorHandlerStore</a> </li> </ul> <h1>Class ErrorHandlerStore</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>Error handler store. This store keeps the registered error handlers. Go through the Mesh API to register an error handler.</p> </div> </div> </section> <section class="tsd-panel tsd-hierarchy"> <h3>Hierarchy</h3> <ul class="tsd-hierarchy"> <li> <span class="target">ErrorHandlerStore</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>Methods</h3> <ul class="tsd-index-list"> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_meshhandlerstore_.errorhandlerstore.html#registererrorhandler" class="tsd-kind-icon">register<wbr>Error<wbr>Handler</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_meshhandlerstore_.errorhandlerstore.html#unregistererrorhandler" class="tsd-kind-icon">unregister<wbr>Error<wbr>Handler</a></li> <li class="tsd-kind-method tsd-parent-kind-class"><a href="_lib_meshhandlerstore_.errorhandlerstore.html#workerrorhandler" class="tsd-kind-icon">work<wbr>Error<wbr>Handler</a></li> </ul> </section> </div> </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"> <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/meshHandlerStore.ts#L172">lib/meshHandlerStore.ts:172</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Register an error handler for an error status. There can only be one handler per status.</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"> <a name="unregistererrorhandler" class="tsd-anchor"></a> <h3>unregister<wbr>Error<wbr>Handler</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">unregister<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/meshHandlerStore.ts#L181">lib/meshHandlerStore.ts:181</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Unregister an error handler for a status.</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 unregistered from.</p> </div> </li> <li> <h5><span class="tsd-flag ts-flagOptional">Optional</span> 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 unregistered.</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="workerrorhandler" class="tsd-anchor"></a> <h3>work<wbr>Error<wbr>Handler</h3> <ul class="tsd-signatures tsd-kind-method tsd-parent-kind-class"> <li class="tsd-signature tsd-kind-icon">work<wbr>Error<wbr>Handler<span class="tsd-signature-symbol">(</span>status<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">number</span>, error<span class="tsd-signature-symbol">: </span><span class="tsd-signature-type">any</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">Promise</span><span class="tsd-signature-symbol"><</span><span class="tsd-signature-type">void</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/meshHandlerStore.ts#L194">lib/meshHandlerStore.ts:194</a></li> </ul> </aside> <div class="tsd-comment tsd-typography"> <div class="lead"> <p>Execute the error handler for a status.</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 for which the handler should be executed.</p> </div> </li> <li> <h5>error: <span class="tsd-signature-type">any</span></h5> <div class="tsd-comment tsd-typography"> <p>An object describing the error.</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 MeshRequest.</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 MeshResponse</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">void</span><span class="tsd-signature-symbol">></span></h4> <p>A promise, that will be fulfilled once the error handler has been executed and will be rejected if executing the error handler fails.</p> </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=" tsd-kind-external-module"> <a href="../modules/_lib_mesh_.html">"lib/mesh"</a> </li> <li class="current 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"> </ul> <ul class="current"> <li class="current tsd-kind-class tsd-parent-kind-external-module"> <a href="_lib_meshhandlerstore_.errorhandlerstore.html" class="tsd-kind-icon">Error<wbr>Handler<wbr>Store</a> <ul> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_meshhandlerstore_.errorhandlerstore.html#registererrorhandler" class="tsd-kind-icon">register<wbr>Error<wbr>Handler</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_meshhandlerstore_.errorhandlerstore.html#unregistererrorhandler" class="tsd-kind-icon">unregister<wbr>Error<wbr>Handler</a> </li> <li class=" tsd-kind-method tsd-parent-kind-class"> <a href="_lib_meshhandlerstore_.errorhandlerstore.html#workerrorhandler" class="tsd-kind-icon">work<wbr>Error<wbr>Handler</a> </li> </ul> </li> </ul> <ul class="after-current"> <li class=" tsd-kind-class tsd-parent-kind-external-module"> <a href="_lib_meshhandlerstore_.schemahandlerstore.html" class="tsd-kind-icon">Schema<wbr>Handler<wbr>Store</a> </li> <li class=" tsd-kind-class tsd-parent-kind-external-module"> <a href="_lib_meshhandlerstore_.viewhandlerstore.html" class="tsd-kind-icon">View<wbr>Handler<wbr>Store</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_lib_meshhandlerstore_.imesherrorhandler.html" class="tsd-kind-icon">IMesh<wbr>Error<wbr>Handler</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module tsd-has-type-parameter"> <a href="../interfaces/_lib_meshhandlerstore_.imeshschemahandler.html" class="tsd-kind-icon">IMesh<wbr>Schema<wbr>Handler</a> </li> <li class=" tsd-kind-interface tsd-parent-kind-external-module"> <a href="../interfaces/_lib_meshhandlerstore_.imeshviewhandler.html" class="tsd-kind-icon">IMesh<wbr>View<wbr>Handler</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>