ec.errors/docs/index.html at develop · entrecode/ec.errors

948 lines (724 loc) · 21.6 KB
<!doctype html>
<html lang="en">
  <meta charset='utf-8'>
  <title>ec.errors 0.2.12 | Documentation</title>
  <meta name='description' content='Module for error codes used by all entrecode products. By entrecode.'>
  <meta name='viewport' content='width=device-width,initial-scale=1'>
  <link href='assets/bass.css' rel='stylesheet'>
  <link href='assets/style.css' rel='stylesheet'>
  <link href='assets/github.css' rel='stylesheet'>
  <link href='assets/split.css' rel='stylesheet'>
<body class='documentation m0'>
    <div class='flex'>
      <div id='split-left' class='overflow-auto fs0 height-viewport-100'>
        <div class='py1 px2'>
          <h3 class='mb0 no-anchor'>ec.errors</h3>
          <div class='mb1'><code>0.2.12</code></div>
          <input
            placeholder='Filter'
            id='filter-input'
            class='col12 block input'
            spellcheck='false'
            autocapitalize='off'
            autocorrect='off'
            type='text' />
          <div id='toc'>
            <ul class='list-reset h5 py1-ul'>
                <li><a
                  href='#getting-started'
                  class="h5 bold black caps">
                  Getting Started
                </li>
                <li><a
                  href='#error-codes'
                  class="h5 bold black caps">
                  Error codes
                </li>
                <li><a
                  href='#api-doc'
                  class="h5 bold black caps">
                  API Doc
                </li>
                <li><a
                  href='#newerror'
                  class="">
                  newError
                </li>
                <li><a
                  href='#convertvalidationerror'
                  class="">
                  convertValidationError
                </li>
                <li><a
                  href='#getlocalised'
                  class="">
                  getLocalised
                </li>
                <li><a
                  href='#impressum--datenschutz'
                  class="h5 bold black caps">
                  Impressum &amp; Datenschutz
                </li>
            </ul>
          </div>
          <div class='mt1 h6 quiet'>
            <a href='https://documentation.js.org/reading-documentation.html'>Need help reading this?</a>
          </div>
        </div>
      </div>
      <div id='split-right' class='relative overflow-auto height-viewport-100'>
            <div class='keyline-top-not py2'><section class='py2 clearfix'>
  <h2 id='getting-started' class='mt0'>
    Getting Started
    <h1>ec.errors</h1>
<blockquote>
<p>Module for error codes used by all entrecode products. By entrecode.</p>
</blockquote>
<h2>Installation</h2>
<h2>Basic Usage</h2>
<h2>Configuration</h2>
<p>This module has the following configuration options (and their defaults). In order to overwrite with your own config pass an object to the require call.</p>
<h2>Changelog</h2>
<h3>v0.2.0</h3>
<li>removed <code>node-config</code></li>
<li>switched to module factory style module to support frontend transpilation</li>
<h4>v0.1.3</h4>
<li>fix: load errorCodes with file extension, should fix webpack build</li>
<h4>v0.1.2</h4>
<li>feat: adds typings</li>
<h4>v0.1.1</h4>
<li>fix: fixed error array conversion in mapTV4Error</li>
<h3>v0.1.0</h3>
<li>initial version published from private module ec.appcms-node-util</li>
<li>feat: newError(code, detail, verbose) for error creation</li>
<li>feat: convertValidationError(tv4Result) for mapping tv4 validation errors into entrecode style errors</li>
</section></div>
            <div class='keyline-top-not py2'><section class='py2 clearfix'>
  <h2 id='error-codes' class='mt0'>
    Error codes
    <h1>Error Codes</h1>
<th>code</th>
<th>message</th>
<th>message (de)</th>
<th>status</th>
<td>100</td>
<td>Resource not found</td>
<td>Resource nicht gefunden</td>
<td>404</td>
<td>101</td>
<td>No resource entity matching body property filter found</td>
<td>Keine zu den Body-Parametern passende Resource gefunden</td>
<td>404</td>
<td>102</td>
<td>No resource entity matching query string filter found</td>
<td>Keine zu den Query-Parametern passende Resoruce gefunden</td>
<td>404</td>
<td>110</td>
<td>Method not allowed</td>
<td>Methode nicht erlaubt</td>
<td>405</td>
<td>112</td>
<td>Somebody else changed the resource</td>
<td>Resource wurde von jemand anderem verändert</td>
<td>412</td>
<td>150</td>
<td>Error in Remote API</td>
<td>Fehler in Remote-API</td>
<td>400</td>
<td>200</td>
<td>Missing body</td>
<td>Fehlender Body</td>
<td>400</td>
<td>201</td>
<td>Missing property in JSON body</td>
<td>Fehlender Parameter im JSON Body</td>
<td>400</td>
<td>202</td>
<td>Missing property in query string</td>
<td>Fehlender Parameter im Query-String</td>
<td>400</td>
<td>203</td>
<td>Missing file in upload</td>
<td>undefined</td>
<td>400</td>
<td>204</td>
<td>Missing HAL link or embed in JSON body</td>
<td>Fehlender HAL Link oder eingebettete Resource</td>
<td>400</td>
<td>211</td>
<td>Invalid format for property in JSON body</td>
<td>Fehlerhaftes format für JSON Body Parameter</td>
<td>400</td>
<td>212</td>
<td>Invalid format for property in query string</td>
<td>Fehlerhaftes format für Query-String Parameter</td>
<td>400</td>
<td>213</td>
<td>Invalid file format in upload</td>
<td>Fehlerhaftes Dateiformat im Upload</td>
<td>400</td>
<td>214</td>
<td>Invalid linked or embedded HAL resource in JSON body, or link not found</td>
<td>Fehlerhafte verlinkte oder eingebettete HAL Resrouce im JSON Body, oder Linkt nicht gefunden</td>
<td>400</td>
<td>215</td>
<td>Resource cannot be sorted after given property</td>
<td>Resource kann nicht mit übergebenem Parameter sortiert werden</td>
<td>400</td>
<td>216</td>
<td>Resource cannot be filtered with given property</td>
<td>Resource kann nicht mit übergebenem Parameter gefiltert werden</td>
<td>400</td>
<td>217</td>
<td>Resource cannot be range-filtered with given property</td>
<td>Resource kann nicht mit übergebenem Parameter bereichs-gefiltert werden</td>
<td>400</td>
<td>251</td>
<td>Password is too short (min. 4 characters)</td>
<td>Passwort zu kurt (min. 4 Zeichen)</td>
<td>400</td>
<td>252</td>
<td>Unmatched validation error</td>
<td>Nicht abgefangener Validierungsfehler</td>
<td>400</td>
<td>253</td>
<td>Invalid asset to merge</td>
<td>Fehlerhaftes Asset zum Zusammenführen</td>
<td>400</td>
<td>254</td>
<td>Exceeded maximum levels for nested request.</td>
<td>undefined</td>
<td>400</td>
<td>255</td>
<td>Could not get nested resources.</td>
<td>Konnte eingebettete Resource nicht laden</td>
<td>400</td>
<td>256</td>
<td>Could not create download file.</td>
<td>Konnte Download Datei nicht erstellen</td>
<td>400</td>
<td>257</td>
<td>Could not load asset by url.</td>
<td>Konnte Asset per url nicht laden.</td>
<td>400</td>
<td>311</td>
<td>Invalid value for property in JSON body</td>
<td>Fehlerhaftes Wert für Parameter im JSON Body</td>
<td>400</td>
<td>351</td>
<td>Email address is unavailable</td>
<td>E-Mail-Adresse nicht verfügbar</td>
<td>403</td>
<td>352</td>
<td>Cannot delete openID connection</td>
<td>Kann openID Verbindung nicht löschen</td>
<td>403</td>
<td>353</td>
<td>Duplicate model/assetgroup in same data manager</td>
<td>Doppeltes Model/doppelte Asset Group im gleichen DataManager</td>
<td>403</td>
<td>354</td>
<td>Cannot delete model, has entries</td>
<td>Kann Model nicht löschen, hat Entries</td>
<td>403</td>
<td>355</td>
<td>Kann Model nicht löschen, zwingend notwendig</td>
<td>undefined</td>
<td>403</td>
<td>356</td>
<td>Cannot change Model, has Entries.</td>
<td>Kann Model nicht ändern, hat Entries</td>
<td>403</td>
<td>357</td>
<td>Model must support default locale</td>
<td>Model muss standart Localisierung unterstützen</td>
<td>400</td>
<td>358</td>
<td>Unsupported locale</td>
<td>Nicht unterstützte Localisierung</td>
<td>400</td>
<td>359</td>
<td>Violates unique constraint</td>
<td>Verletzt Einzigartigkeit</td>
<td>400</td>
<td>360</td>
<td>Cannot delete entry. Referenced as required.</td>
<td>Kann Entry nicht löschen. Als erforderlich referenziert</td>
<td>400</td>
<td>361</td>
<td>Cannot change entry. Read Only.</td>
<td>Kann entry nicht ändern. Ist Schreibgeschützt</td>
<td>403</td>
<td>362</td>
<td>Cannot change entry. Reference not allowed due to type validation.</td>
<td>Kann Entry nicht ändern. Referenz nicht erlaubt, fehlerhafte Typ-Validierung</td>
<td>400</td>
<td>363</td>
<td>Cannot change Model, edit of mandatory/unmutable field.</td>
<td>Kann Model nicht ändern. Änderung von Systemfeldern nicht erlaubt</td>
<td>403</td>
<td>364</td>
<td>Cannot change Model, reserved field title.</td>
<td>Kann Model nicht ändern. Reservierter Feldname</td>
<td>400</td>
<td>365</td>
<td>Cannot change Model, duplicate model title.</td>
<td>Kann Model nicht ändern. Doppelter Model name</td>
<td>400</td>
<td>366</td>
<td>Duplicate field name in model.</td>
<td>Doppelter Feldname im Model.</td>
<td>400</td>
<td>367</td>
<td>Field cannot be unique and localizable.</td>
<td>Feld kann nicht gleichzeitig einzigartig und lokalisierbar sein</td>
<td>400</td>
<td>368</td>
<td>Field of type boolean must be required.</td>
<td>Felder mit typ Boolean müssen erforderlich sein</td>
<td>400</td>
<td>369</td>
<td>Title field not a field in the model.</td>
<td>Titelfeld nicht als Feld im Model gefunden</td>
<td>400</td>
<td>370</td>
<td>Cannot delete resource. Is used.</td>
<td>Kann Resource nicht löschen, wird verwendet</td>
<td>403</td>
<td>371</td>
<td>Cannot change entry. Reference not found.</td>
<td>Kann Entry nicht ändern. Referenz nicht gefunden</td>
<td>400</td>
<td>372</td>
<td>Required field must have a default value set.</td>
<td>Erforderliche Felder müssen Standartwert gesetzt haben.</td>
<td>400</td>
<td>373</td>
<td>Other parallel request already added tag(s)</td>
<td>Anderer paralleler Request hat Tag schon bearbeitet</td>
<td>400</td>
<td>374</td>
<td>Cannot export datamanager. Required field in model has no default value.</td>
<td>Kann DataManager nicht exportieren. Erforderliches Feld in Model hat keinen Standartwert</td>
<td>400</td>
<td>375</td>
<td>A duplicate asset already exists in this AssetGroup. Set <code>ignoreDuplicates</code> flag to ignore. No assets were uploaded.</td>
<td>Ein gleiches Asset existiert bereits in dieser AssetGroup. Zum Ignorieren <code>ignoreDuplicates</code> flag setzten. Kein Asset wurde Hochgeladen</td>
<td>400</td>
<td>376</td>
<td>A duplicate asset filename already exists in this AssetGroup. Remove <code>preserveFilenames</code> flag to use a random filename. No assets were uploaded.</td>
<td>Ein Asset mit gleichem Dateinamen existiert bereits in dieser AssetGroup. <code>preserveFilenames</code> flag entfernen um zufälligen Dateinamen zu verwenden. Kein Asset wurde Hochgeladen</td>
<td>400</td>
<td>377</td>
<td>Could not delete entry, linked entry parallel deleted</td>
<td>Konnte Entry nicht löschen. Verknüpfter Entry parallel gelöscht</td>
<td>409</td>
<td>400</td>
<td>Missing Access Token</td>
<td>Fehlender Access Token</td>
<td>401</td>
<td>401</td>
<td>Invalid Access Token</td>
<td>Fehlerhafter Access Token</td>
<td>401</td>
<td>402</td>
<td>Outdated Access Token</td>
<td>Access Token abgelaufen</td>
<td>401</td>
<td>403</td>
<td>Invalid Password</td>
<td>Falsches Passwort</td>
<td>401</td>
<td>404</td>
<td>Account not found (unknown email address)</td>
<td>Account nicht gefunden (unbekannte E-Mail-Adresse)</td>
<td>404</td>
<td>410</td>
<td>Insufficient rights to access the requested resource</td>
<td>Keine Berechtigung die angeforderte Resource zu laden</td>
<td>401</td>
<td>411</td>
<td>Insufficient rights to access the requested resource with this method</td>
<td>Keine Berechtigung die angeforderte Resource mit dieser Methode zu laden</td>
<td>405</td>
<td>444</td>
<td>Denied because of stupidity</td>
<td><a href="http://www.nichtlustig.de/toondb/040816.html">http://www.nichtlustig.de/toondb/040816.html</a></td>
<td>403</td>
<td>451</td>
<td>Too many wrong login attempts, please wait</td>
<td>Zu viele Login-Versuche. Bitte warten</td>
<td>429</td>
<td>452</td>
<td>User blocked</td>
<td>Benutzer blockiert</td>
<td>403</td>
<td>453</td>
<td>Invalid invite</td>
<td>Fehlerhafte Einladung</td>
<td>403</td>
<td>454</td>
<td>Not allowed for this Account</td>
<td>Für diesen Account nicht erlaubt</td>
<td>403</td>
<td>455</td>
<td>Maximum amount reached</td>
<td>Maximale Anzahl erreicht</td>
<td>403</td>
<td>456</td>
<td>Wrong email in invite</td>
<td>Falsche E-Mail im Invite</td>
<td>403</td>
<td>460</td>
<td>Generic OAuth Error</td>
<td>Allgemeint OAuth Fehler</td>
<td>400</td>
<td>461</td>
<td>Facebook OAuth Request failed</td>
<td>Facebook OAuth fehlgeschlagen</td>
<td>400</td>
<td>462</td>
<td>Facebook API call failed to receive email address</td>
<td>Facebook Request konnte E-Mail-Adresse nicht laden</td>
<td>400</td>
<td>465</td>
<td>OAuth Error</td>
<td>OAuth Error</td>
<td>400</td>
<td>470</td>
<td>Target resource does not fulfill permission policy conditions</td>
<td>Resource erfüllt Bedingung für Berechtigung nicht</td>
<td>403</td>
<td>471</td>
<td>Property cannot be written due to permission policy restrictions</td>
<td>Parameter kann nicht geschrieben werden auf grund von eingeschränkter Richtlinie</td>
<td>403</td>
<td>472</td>
<td>Error while processing asset file</td>
<td>Fehler beim bearbeiten der Datei</td>
<td>400</td>
<td>473</td>
<td>Error running template</td>
<td>Fehler beim Ausführen der Template</td>
<td>400</td>
<td>500</td>
<td>Missing plan for this product</td>
<td>Fehlender Vertrag für dieses Produkt</td>
<td>403</td>
<td>510</td>
<td>Insufficient plan for this product</td>
<td>Vertrag umfasst dieses Produkt nicht</td>
<td>403</td>
<td>511</td>
<td>Insufficient plan for creation</td>
<td>Kann dies im aktuellen Vertrag nicht erstellen</td>
<td>403</td>
<td>003</td>
<td>Service currently unavailable</td>
<td>undefined</td>
<td>503</td>
<td>002</td>
<td>Bad Gateway</td>
<td>undefined</td>
<td>502</td>
<td>000</td>
<td>Internal Error</td>
<td>undefined</td>
<td>500</td>
</section></div>
            <div class='keyline-top-not py2'><section class='py2 clearfix'>
  <h2 id='api-doc' class='mt0'>
    API Doc
</section></div>
          <section class='p2 mb2 clearfix bg-white minishadow'>
  <div class='clearfix'>
    <h3 class='fl m0' id='newerror'>
      newError
  <p>Helper Function to produce an error object containing message and HTTP status code.</p>
    <div class='pre p1 fill-light mt0'>newError(code: (int | <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?), detail: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?, verbose: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></div>
    <div class='py1 quiet mt1 prose-big'>Parameters</div>
    <div class='prose'>
        <div class='space-bottom0'>
          <div>
            <span class='code bold'>code</span> <code class='quiet'>((int | <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?)
            = <code>&#39;000&#39;</code>)</code>
	    internal error code without system identifier (three digits).
Can also be an integer (when not 000…).
          </div>
        </div>
        <div class='space-bottom0'>
          <div>
            <span class='code bold'>detail</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?
            = <code>&#39;&#39;</code>)</code>
	    subject the error concerns.
          </div>
        </div>
        <div class='space-bottom0'>
          <div>
            <span class='code bold'>verbose</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?
            = <code>&#39;&#39;</code>)</code>
	    even more information about the error.
          </div>
        </div>
      <div class='py1 quiet mt1 prose-big'>Returns</div>
      <code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></code>:
        An JavaScript Error instance.
          <section class='p2 mb2 clearfix bg-white minishadow'>
  <div class='clearfix'>
    <h3 class='fl m0' id='convertvalidationerror'>
      convertValidationError
  <p>Converts an Error of tini validator into entrecode error format.</p>
    <div class='pre p1 fill-light mt0'>convertValidationError(tv4Result: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></div>
    <div class='py1 quiet mt1 prose-big'>Parameters</div>
    <div class='prose'>
        <div class='space-bottom0'>
          <div>
            <span class='code bold'>tv4Result</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Object">object</a>)</code>
	    Error from tini validator.
          </div>
        </div>
      <div class='py1 quiet mt1 prose-big'>Returns</div>
      <code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></code>:
        Mapped error in entrecode format.
          <section class='p2 mb2 clearfix bg-white minishadow'>
  <div class='clearfix'>
    <h3 class='fl m0' id='getlocalised'>
      getLocalised
  <p>Create a localized version of any given entrecode error.</p>
    <div class='pre p1 fill-light mt0'>getLocalised(error: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>, locale: <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?): <a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></div>
    <div class='py1 quiet mt1 prose-big'>Parameters</div>
    <div class='prose'>
        <div class='space-bottom0'>
          <div>
            <span class='code bold'>error</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a>)</code>
	    Error in entrecode error format.
          </div>
        </div>
        <div class='space-bottom0'>
          <div>
            <span class='code bold'>locale</span> <code class='quiet'>(<a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/String">string</a>?
            = <code>config.locale</code>)</code>
	    Two character localization (currently only 'de' supported).
Leave blank for english.
          </div>
        </div>
      <div class='py1 quiet mt1 prose-big'>Returns</div>
      <code><a href="https://developer.mozilla.org/docs/Web/JavaScript/Reference/Global_Objects/Error">Error</a></code>:
        localized entrecode error.
            <div class='keyline-top-not py2'><section class='py2 clearfix'>
  <h2 id='impressum--datenschutz' class='mt0'>
    Impressum &amp; Datenschutz
    <p><a href="https://entrecode.de/datenschutz">Impressum &#x26; Datenschutz (Privacy)</a></p>
</section></div>
      </div>
  <script src='assets/anchor.js'></script>
  <script src='assets/split.js'></script>
  <script src='assets/site.js'></script>
Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

FilesExpand file tree

index.html

Latest commit

History

index.html

File metadata and controls
