CommunitySolidServer/docs/interfaces/util_errors_systemerror.systemerror.html
2021-01-02 22:56:16 +00:00

361 lines
17 KiB
HTML

<!doctype html>
<html class="default no-js">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<title>SystemError | Community Solid Server</title>
<meta name="description" content="Documentation for Community Solid Server">
<meta name="viewport" content="width=device-width, initial-scale=1">
<link rel="stylesheet" href="../assets/css/main.css">
<script async src="../assets/js/search.js" id="search-script"></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.json" 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">Community Solid Server</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>
</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="../modules.html">Community Solid Server</a>
</li>
<li>
<a href="../modules/util_errors_systemerror.html">util/errors/SystemError</a>
</li>
<li>
<a href="util_errors_systemerror.systemerror.html">SystemError</a>
</li>
</ul>
<h1>Interface SystemError</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>Interface for Node.js System errors</p>
</div>
<p>Node.js generates system errors when exceptions occur within its runtime environment.
These usually occur when an application violates an operating system constraint.
For example, a system error will occur if an application attempts to read a file that does not exist.</p>
</div>
</section>
<section class="tsd-panel tsd-hierarchy">
<h3>Hierarchy</h3>
<ul class="tsd-hierarchy">
<li>
<span class="tsd-signature-type">Error</span>
<ul class="tsd-hierarchy">
<li>
<span class="target">SystemError</span>
</li>
</ul>
</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>Properties</h3>
<ul class="tsd-index-list">
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="util_errors_systemerror.systemerror.html#address" class="tsd-kind-icon">address</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="util_errors_systemerror.systemerror.html#code" class="tsd-kind-icon">code</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="util_errors_systemerror.systemerror.html#dest" class="tsd-kind-icon">dest</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="util_errors_systemerror.systemerror.html#errno" class="tsd-kind-icon">errno</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="util_errors_systemerror.systemerror.html#info" class="tsd-kind-icon">info</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="util_errors_systemerror.systemerror.html#message" class="tsd-kind-icon">message</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="util_errors_systemerror.systemerror.html#name" class="tsd-kind-icon">name</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="util_errors_systemerror.systemerror.html#path" class="tsd-kind-icon">path</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="util_errors_systemerror.systemerror.html#port" class="tsd-kind-icon">port</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface tsd-is-external"><a href="util_errors_systemerror.systemerror.html#stack" class="tsd-kind-icon">stack</a></li>
<li class="tsd-kind-property tsd-parent-kind-interface"><a href="util_errors_systemerror.systemerror.html#syscall" class="tsd-kind-icon">syscall</a></li>
</ul>
</section>
</div>
</section>
</section>
<section class="tsd-panel-group tsd-member-group ">
<h2>Properties</h2>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="address" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> address</h3>
<div class="tsd-signature tsd-kind-icon">address<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c7dd6db/src/util/errors/SystemError.ts#L12">src/util/errors/SystemError.ts:12</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If present, the address to which a network connection failed.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="code" class="tsd-anchor"></a>
<h3>code</h3>
<div class="tsd-signature tsd-kind-icon">code<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c7dd6db/src/util/errors/SystemError.ts#L17">src/util/errors/SystemError.ts:17</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The string error code.
Full list: <a href="https://man7.org/linux/man-pages/man3/errno.3.html">https://man7.org/linux/man-pages/man3/errno.3.html</a></p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="dest" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> dest</h3>
<div class="tsd-signature tsd-kind-icon">dest<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c7dd6db/src/util/errors/SystemError.ts#L21">src/util/errors/SystemError.ts:21</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If present, the file path destination when reporting a file system error.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="errno" class="tsd-anchor"></a>
<h3>errno</h3>
<div class="tsd-signature tsd-kind-icon">errno<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">number</span><span class="tsd-signature-symbol"> | </span><span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c7dd6db/src/util/errors/SystemError.ts#L25">src/util/errors/SystemError.ts:25</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The system-provided error number.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="info" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> info</h3>
<div class="tsd-signature tsd-kind-icon">info<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">any</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c7dd6db/src/util/errors/SystemError.ts#L29">src/util/errors/SystemError.ts:29</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If present, extra details about the error condition.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="message" class="tsd-anchor"></a>
<h3>message</h3>
<div class="tsd-signature tsd-kind-icon">message<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:974</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="name" class="tsd-anchor"></a>
<h3>name</h3>
<div class="tsd-signature tsd-kind-icon">name<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:973</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="path" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> path</h3>
<div class="tsd-signature tsd-kind-icon">path<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c7dd6db/src/util/errors/SystemError.ts#L33">src/util/errors/SystemError.ts:33</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If present, the file path when reporting a file system error.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="port" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> port</h3>
<div class="tsd-signature tsd-kind-icon">port<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c7dd6db/src/util/errors/SystemError.ts#L37">src/util/errors/SystemError.ts:37</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>If present, the network connection port that is not available.</p>
</div>
</div>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a name="stack" class="tsd-anchor"></a>
<h3><span class="tsd-flag ts-flagOptional">Optional</span> stack</h3>
<div class="tsd-signature tsd-kind-icon">stack<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in node_modules/typescript/lib/lib.es5.d.ts:975</li>
</ul>
</aside>
</section>
<section class="tsd-panel tsd-member tsd-kind-property tsd-parent-kind-interface">
<a name="syscall" class="tsd-anchor"></a>
<h3>syscall</h3>
<div class="tsd-signature tsd-kind-icon">syscall<span class="tsd-signature-symbol">:</span> <span class="tsd-signature-type">string</span></div>
<aside class="tsd-sources">
<ul>
<li>Defined in <a href="https://github.com/solid/community-server/blob/c7dd6db/src/util/errors/SystemError.ts#L41">src/util/errors/SystemError.ts:41</a></li>
</ul>
</aside>
<div class="tsd-comment tsd-typography">
<div class="lead">
<p>The name of the system call that triggered the error.</p>
</div>
</div>
</section>
</section>
</div>
<div class="col-4 col-menu menu-sticky-wrap menu-highlight">
<nav class="tsd-navigation primary">
<ul>
<li class=" ">
<a href="../modules.html">Exports</a>
</li>
<li class="current tsd-kind-module">
<a href="../modules/util_errors_systemerror.html">util/errors/<wbr>System<wbr>Error</a>
</li>
</ul>
</nav>
<nav class="tsd-navigation secondary menu-sticky">
<ul class="before-current">
</ul>
<ul class="current">
<li class="current tsd-kind-interface tsd-parent-kind-module">
<a href="util_errors_systemerror.systemerror.html" class="tsd-kind-icon">System<wbr>Error</a>
<ul>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="util_errors_systemerror.systemerror.html#address" class="tsd-kind-icon">address</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="util_errors_systemerror.systemerror.html#code" class="tsd-kind-icon">code</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="util_errors_systemerror.systemerror.html#dest" class="tsd-kind-icon">dest</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="util_errors_systemerror.systemerror.html#errno" class="tsd-kind-icon">errno</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="util_errors_systemerror.systemerror.html#info" class="tsd-kind-icon">info</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="util_errors_systemerror.systemerror.html#message" class="tsd-kind-icon">message</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="util_errors_systemerror.systemerror.html#name" class="tsd-kind-icon">name</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="util_errors_systemerror.systemerror.html#path" class="tsd-kind-icon">path</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="util_errors_systemerror.systemerror.html#port" class="tsd-kind-icon">port</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface tsd-is-external">
<a href="util_errors_systemerror.systemerror.html#stack" class="tsd-kind-icon">stack</a>
</li>
<li class=" tsd-kind-property tsd-parent-kind-interface">
<a href="util_errors_systemerror.systemerror.html#syscall" class="tsd-kind-icon">syscall</a>
</li>
</ul>
</li>
</ul>
<ul class="after-current">
<li class=" tsd-kind-function tsd-parent-kind-module">
<a href="../modules/util_errors_systemerror.html#issystemerror" class="tsd-kind-icon">is<wbr>System<wbr>Error</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<footer>
<div class="container">
<h2>Legend</h2>
<div class="tsd-legend-group">
<ul class="tsd-legend">
<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-type-alias"><span class="tsd-kind-icon">Type alias</span></li>
<li class="tsd-kind-type-alias tsd-has-type-parameter"><span class="tsd-kind-icon">Type alias with type parameter</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-property tsd-parent-kind-interface"><span class="tsd-kind-icon">Property</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>
</ul>
</div>
</div>
</footer>
<div class="overlay"></div>
<script src="../assets/js/main.js"></script>
</body>
</html>