balena-cli/doc/file/lib/resin/errors/errors.coffee.html

<!DOCTYPE html>
<html>
  <head>
  <meta charset='UTF-8'>
  <title>CoffeeScript API Documentation</title>
  <script src='../../../../javascript/application.js'></script>
  <script src='../../../../javascript/search.js'></script>
  <link rel='stylesheet' href='../../../../stylesheets/application.css' type='text/css'>
</head>
  <body>
    <div id='base' data-path='../../../../'></div>
<div id='header'>
  <div id='menu'>
    <a href='../../../../alphabetical_index.html' title='Index'>
      Index
    </a>
    &raquo;
    <span class='title'>lib</span>
    &raquo;
    <span class='title'>resin</span>
    &raquo;
    <span class='title'>errors</span>
    &raquo;
    <span class='title'>errors.coffee</span>
  </div>
</div>
    <div id='content'>
      <h1>
        File:
        errors.coffee
      </h1>
      <table class='box'>
        <tr>
          <td>Defined in:</td>
          <td>lib&#47;resin&#47;errors</td>
        </tr>
      </table>
      <h2>Method Summary</h2>
      <ul class='summary'>
  <li>
    <span class='signature'>
      <a href='#handle-'>
        ~
(void)
<b>handle</b><span>(error, exit = true)</span>
      </a>
    </span>
    <span class='desc'>
      Handle error instances <p>Prints the message to stderr and aborts the program with the corresponding error code, or 0 if none.</p>
    </span>
  </li>
</ul>
      <h2>Method Details</h2>
      <div class='methods'>
  <div class='method_details'>
    <p class='signature' id='handle-'>
      ~
(void)
<b>handle</b><span>(error, exit = true)</span>
      <br>
    </p>
    <div class='docstring'>
  <p>Handle error instances</p><p>Prints the message to stderr and aborts the program with the corresponding error code, or 0 if none.</p><pre><code>error = new Error(&#39;My Error&#39;)
shouldExit = false
resin.errors.handle(error, shouldExit)
</code></pre>
</div>
<div class='tags'>
  <h3>Parameters:</h3>
  <ul class='param'>
    <li>
      <span class='name'>error</span>
      <span class='type'>
        (
          <tt>Error</tt>
        )
      </span>
      &mdash;
      <span class='desc'>the error instance </span>
    </li>
    <li>
      <span class='name'>exit</span>
      <span class='type'>
        (
          <tt>Boolean</tt>
        )
      </span>
      &mdash;
      <span class='desc'>whether to exit or not (defaults to true) </span>
    </li>
  </ul>
</div>
  </div>
</div>
    </div>
    <div id='footer'>
  December 08, 14 09:16:28 by
  <a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>
    Codo
  </a>
  2.0.9
  &#10034;
  Press H to see the keyboard shortcuts
  &#10034;
  <a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>
  &#10034;
  <a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>
</div>
<iframe id='search_frame'></iframe>
<div id='fuzzySearch'>
  <input type='text'>
  <ol></ol>
</div>
<div id='help'>
  <p>
    Quickly fuzzy find classes, mixins, methods, file:
  </p>
  <ul>
    <li>
      <span>T</span>
      Open fuzzy finder dialog
    </li>
  </ul>
  <p>
    Control the navigation frame:
  </p>
  <ul>
    <li>
      <span>L</span>
      Toggle list view
    </li>
    <li>
      <span>C</span>
      Show class list
    </li>
    <li>
      <span>I</span>
      Show mixin list
    </li>
    <li>
      <span>F</span>
      Show file list
    </li>
    <li>
      <span>M</span>
      Show method list
    </li>
    <li>
      <span>E</span>
      Show extras list
    </li>
  </ul>
  <p>
    You can focus and blur the search input:
  </p>
  <ul>
    <li>
      <span>S</span>
      Focus search input
    </li>
    <li>
      <span>Esc</span>
      Blur search input
    </li>
  </ul>
</div>
  </body>
</html>
Stage generated codo documentation 2014-12-08 08:49:23 -04:00			`<!DOCTYPE html>`
			`<html>`
			`<head>`
			`<meta charset='UTF-8'>`
			`<title>CoffeeScript API Documentation</title>`
			`<script src='../../../../javascript/application.js'></script>`
			`<script src='../../../../javascript/search.js'></script>`
			`<link rel='stylesheet' href='../../../../stylesheets/application.css' type='text/css'>`
			`</head>`
			`<body>`
			`<div id='base' data-path='../../../../'></div>`
			`<div id='header'>`
			`<div id='menu'>`
			`<a href='../../../../alphabetical_index.html' title='Index'>`
			`Index`
			`</a>`
			`»`
			`<span class='title'>lib</span>`
			`»`
			`<span class='title'>resin</span>`
			`»`
			`<span class='title'>errors</span>`
			`»`
			`<span class='title'>errors.coffee</span>`
			`</div>`
			`</div>`
			`<div id='content'>`
			`<h1>`
			`File:`
			`errors.coffee`
			`</h1>`
			`<table class='box'>`
			`<tr>`
			`<td>Defined in:</td>`
			`<td>lib/resin/errors</td>`
			`</tr>`
			`</table>`
			`<h2>Method Summary</h2>`
			`<ul class='summary'>`
			`<li>`
			`<span class='signature'>`
			`<a href='#handle-'>`
			`~`
			`(void)`
			`<b>handle</b><span>(error, exit = true)</span>`
			`</a>`
			`</span>`
			`<span class='desc'>`
			`Handle error instances <p>Prints the message to stderr and aborts the program with the corresponding error code, or 0 if none.</p>`
			`</span>`
			`</li>`
			`</ul>`
			`<h2>Method Details</h2>`
			`<div class='methods'>`
			`<div class='method_details'>`
			`<p class='signature' id='handle-'>`
			`~`
			`(void)`
			`<b>handle</b><span>(error, exit = true)</span>`
			`<br>`
			`</p>`
			`<div class='docstring'>`
			`<p>Handle error instances</p><p>Prints the message to stderr and aborts the program with the corresponding error code, or 0 if none.</p><pre><code>error = new Error('My Error')`
			`shouldExit = false`
			`resin.errors.handle(error, shouldExit)`
			`</code></pre>`
			`</div>`
			`<div class='tags'>`
			`<h3>Parameters:</h3>`
			`<ul class='param'>`
			`<li>`
			`<span class='name'>error</span>`
			`<span class='type'>`
			`(`
			`<tt>Error</tt>`
			`)`
			`</span>`
			`—`
			`<span class='desc'>the error instance </span>`
			`</li>`
			`<li>`
			`<span class='name'>exit</span>`
			`<span class='type'>`
			`(`
			`<tt>Boolean</tt>`
			`)`
			`</span>`
			`—`
			`<span class='desc'>whether to exit or not (defaults to true) </span>`
			`</li>`
			`</ul>`
			`</div>`
			`</div>`
			`</div>`
			`</div>`
			`<div id='footer'>`
Add doc npm script 2014-12-08 09:17:21 -04:00			`December 08, 14 09:16:28 by`
Stage generated codo documentation 2014-12-08 08:49:23 -04:00			`<a href='https://github.com/coffeedoc/codo' title='CoffeeScript API documentation generator'>`
			`Codo`
			`</a>`
			`2.0.9`
			`✲`
			`Press H to see the keyboard shortcuts`
			`✲`
			`<a href='http://twitter.com/netzpirat' target='_parent'>@netzpirat</a>`
			`✲`
			`<a href='http://twitter.com/_inossidabile' target='_parent'>@_inossidabile</a>`
			`</div>`
			`<iframe id='search_frame'></iframe>`
			`<div id='fuzzySearch'>`
			`<input type='text'>`
			`<ol></ol>`
			`</div>`
			`<div id='help'>`
			`<p>`
			`Quickly fuzzy find classes, mixins, methods, file:`
			`</p>`
			`<ul>`
			`<li>`
			`<span>T</span>`
			`Open fuzzy finder dialog`
			`</li>`
			`</ul>`
			`<p>`
			`Control the navigation frame:`
			`</p>`
			`<ul>`
			`<li>`
			`<span>L</span>`
			`Toggle list view`
			`</li>`
			`<li>`
			`<span>C</span>`
			`Show class list`
			`</li>`
			`<li>`
			`<span>I</span>`
			`Show mixin list`
			`</li>`
			`<li>`
			`<span>F</span>`
			`Show file list`
			`</li>`
			`<li>`
			`<span>M</span>`
			`Show method list`
			`</li>`
			`<li>`
			`<span>E</span>`
			`Show extras list`
			`</li>`
			`</ul>`
			`<p>`
			`You can focus and blur the search input:`
			`</p>`
			`<ul>`
			`<li>`
			`<span>S</span>`
			`Focus search input`
			`</li>`
			`<li>`
			`<span>Esc</span>`
			`Blur search input`
			`</li>`
			`</ul>`
			`</div>`
			`</body>`
			`</html>`