mirror of
https://github.com/misskey-dev/SyslogPro.git
synced 2025-08-04 23:23:56 +09:00
updated documents
This commit is contained in:
@ -49,18 +49,18 @@
|
||||
RFC5424
|
||||
</h2>
|
||||
|
||||
<div class="class-description">A class to work with RFC5424 formated syslog messages. The meesaging is fully configurabule and Ansi foreground
|
||||
colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.
|
||||
<div class="class-description">A class to work with RFC5424 formatted syslog messages. The messaging is fully configurable and ANSI foreground
|
||||
colors can be added. Both ANSI 8 and ANSI 256 color are fully supported.
|
||||
Most APIs will return a promise. These APIs can be used using
|
||||
`then(...)/catch(...)`
|
||||
|
||||
A Syslog class with a configured
|
||||
Syslog server target can also be used as the input into the formating
|
||||
classes so that it may run independtly.
|
||||
Syslog server target can also be used as the input into the formatting
|
||||
classes so that it may run independently.
|
||||
|
||||
The RFC5424 Syslog logging format is ment to be used as a stream of log data
|
||||
from a service or applacation. This class is designed to be used in this
|
||||
fashion where new messages are writen to the class as needed.</div>
|
||||
The RFC5424 Syslog logging format is meant to be used as a stream of log data
|
||||
from a service or application. This class is designed to be used in this
|
||||
fashion where new messages are written to the class as needed.</div>
|
||||
|
||||
|
||||
</header>
|
||||
@ -87,7 +87,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1028">line 1028</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1027">line 1027</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -133,7 +133,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Construct a new RFC5424 formated Syslog object with user options
|
||||
Construct a new RFC5424 formatted Syslog object with user options
|
||||
</div>
|
||||
|
||||
|
||||
@ -261,7 +261,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last">Applacation</td>
|
||||
<td class="description last">Application</td>
|
||||
</tr>
|
||||
|
||||
|
||||
@ -378,7 +378,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
</td>
|
||||
|
||||
|
||||
<td class="description last">RFC tandard is for
|
||||
<td class="description last">RFC standard is for
|
||||
local time</td>
|
||||
</tr>
|
||||
|
||||
@ -419,7 +419,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<td class="description last">Timestamp with ms
|
||||
resoltuion</td>
|
||||
resolution</td>
|
||||
</tr>
|
||||
|
||||
|
||||
@ -459,7 +459,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<td class="description last">Should the timestamp
|
||||
included timezone</td>
|
||||
included time zone</td>
|
||||
</tr>
|
||||
|
||||
|
||||
@ -655,7 +655,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<td class="description last">User defended colors for
|
||||
severites
|
||||
severities
|
||||
<h6>Properties</h6>
|
||||
|
||||
|
||||
@ -1073,7 +1073,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1145">line 1145</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1144">line 1144</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1132,7 +1132,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1123">line 1123</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1122">line 1122</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1201,7 +1201,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1081">line 1081</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1080">line 1080</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1260,7 +1260,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1147">line 1147</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1146">line 1146</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1319,7 +1319,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1157">line 1157</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1156">line 1156</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1378,7 +1378,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1143">line 1143</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1142">line 1142</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1437,7 +1437,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1111">line 1111</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1110">line 1110</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1506,7 +1506,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1149">line 1149</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1148">line 1148</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1565,7 +1565,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1129">line 1129</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1128">line 1128</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1634,7 +1634,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1155">line 1155</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1154">line 1154</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1693,7 +1693,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1153">line 1153</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1152">line 1152</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1752,7 +1752,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1136">line 1136</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1135">line 1135</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1811,7 +1811,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1087">line 1087</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1086">line 1086</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1880,7 +1880,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1105">line 1105</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1104">line 1104</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -1949,7 +1949,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1099">line 1099</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1098">line 1098</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -2018,7 +2018,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1093">line 1093</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1092">line 1092</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -2087,7 +2087,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1117">line 1117</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1116">line 1116</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -2156,7 +2156,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1151">line 1151</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1150">line 1150</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -2225,7 +2225,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1542">line 1542</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1541">line 1541</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -2265,7 +2265,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 1 (Alert)
|
||||
Send a syslog message with a severity level of 1 (Alert)
|
||||
</div>
|
||||
|
||||
|
||||
@ -2344,7 +2344,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -2372,7 +2372,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -2409,7 +2409,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1361">line 1361</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1360">line 1360</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -2449,7 +2449,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Building a formated message. Returns a promise with a formated message
|
||||
Building a formatted message. Returns a promise with a formatted message
|
||||
</div>
|
||||
|
||||
|
||||
@ -2727,7 +2727,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<td class="description last">An array of structure
|
||||
data strings conforming to the IETF/IANA defined SD-IDs or IANA
|
||||
registred SMI Network Management Private Enterprise Code SD-ID
|
||||
registered SMI Network Management Private Enterprise Code SD-ID
|
||||
conforming to the format
|
||||
[name@<private enterprise number> parameter=value]</td>
|
||||
</tr>
|
||||
@ -2829,7 +2829,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
A Syslog formated string acording to the selected RFC
|
||||
A Syslog formatted string according to the selected RFC
|
||||
</div>
|
||||
|
||||
|
||||
@ -2866,7 +2866,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1568">line 1568</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1567">line 1567</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -2906,7 +2906,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 2 (Critical)
|
||||
Send a syslog message with a severity level of 2 (Critical)
|
||||
</div>
|
||||
|
||||
|
||||
@ -2985,7 +2985,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -3013,7 +3013,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -3050,7 +3050,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1555">line 1555</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1554">line 1554</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -3090,7 +3090,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 2 (Critical)
|
||||
Send a syslog message with a severity level of 2 (Critical)
|
||||
</div>
|
||||
|
||||
|
||||
@ -3169,7 +3169,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -3197,7 +3197,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -3234,7 +3234,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1680">line 1680</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1679">line 1679</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -3274,7 +3274,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 7 (Debug)
|
||||
Send a syslog message with a severity level of 7 (Debug)
|
||||
</div>
|
||||
|
||||
|
||||
@ -3353,7 +3353,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -3381,7 +3381,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -3418,7 +3418,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1532">line 1532</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1531">line 1531</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -3458,7 +3458,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 0 (Emergency)
|
||||
Send a syslog message with a severity level of 0 (Emergency)
|
||||
</div>
|
||||
|
||||
|
||||
@ -3512,7 +3512,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
|
||||
<td class="description last">The emergancy message to send to the Syslog server</td>
|
||||
<td class="description last">The emergency message to send to the Syslog server</td>
|
||||
</tr>
|
||||
|
||||
|
||||
@ -3537,7 +3537,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -3565,7 +3565,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -3602,7 +3602,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1519">line 1519</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1518">line 1518</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -3642,7 +3642,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 0 (Emergency)
|
||||
Send a syslog message with a severity level of 0 (Emergency)
|
||||
</div>
|
||||
|
||||
|
||||
@ -3696,7 +3696,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
|
||||
<td class="description last">The emergancy message to send to the Syslog server</td>
|
||||
<td class="description last">The emergency message to send to the Syslog server</td>
|
||||
</tr>
|
||||
|
||||
|
||||
@ -3721,7 +3721,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -3749,7 +3749,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -3786,7 +3786,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1591">line 1591</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1590">line 1590</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -3826,7 +3826,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 3 (Error)
|
||||
Send a syslog message with a severity level of 3 (Error)
|
||||
</div>
|
||||
|
||||
|
||||
@ -3905,7 +3905,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -3933,7 +3933,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -3970,7 +3970,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1578">line 1578</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1577">line 1577</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -4010,7 +4010,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 3 (Error)
|
||||
Send a syslog message with a severity level of 3 (Error)
|
||||
</div>
|
||||
|
||||
|
||||
@ -4089,7 +4089,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -4117,7 +4117,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -4154,7 +4154,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1660">line 1660</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1659">line 1659</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -4194,7 +4194,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 6 (Informational)
|
||||
Send a syslog message with a severity level of 6 (Informational)
|
||||
</div>
|
||||
|
||||
|
||||
@ -4273,7 +4273,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -4301,7 +4301,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -4338,7 +4338,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1647">line 1647</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1646">line 1646</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -4378,7 +4378,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 6 (Informational)
|
||||
Send a syslog message with a severity level of 6 (Informational)
|
||||
</div>
|
||||
|
||||
|
||||
@ -4457,7 +4457,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -4485,7 +4485,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -4522,7 +4522,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1670">line 1670</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1669">line 1669</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -4562,7 +4562,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 6 (Informational)
|
||||
Send a syslog message with a severity level of 6 (Informational)
|
||||
</div>
|
||||
|
||||
|
||||
@ -4641,7 +4641,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -4669,7 +4669,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -4706,7 +4706,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1637">line 1637</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1636">line 1636</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -4746,7 +4746,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 5 (Notice)
|
||||
Send a syslog message with a severity level of 5 (Notice)
|
||||
</div>
|
||||
|
||||
|
||||
@ -4825,7 +4825,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -4853,7 +4853,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -4890,7 +4890,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1624">line 1624</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1623">line 1623</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -4930,7 +4930,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 5 (Notice)
|
||||
Send a syslog message with a severity level of 5 (Notice)
|
||||
</div>
|
||||
|
||||
|
||||
@ -5009,7 +5009,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -5037,7 +5037,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -5074,7 +5074,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1492">line 1492</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1491">line 1491</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -5121,9 +5121,9 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
send a RFC5424 formated message. Returns a promise with the formated
|
||||
send a RFC5424 formatted message. Returns a promise with the formatted
|
||||
message that was sent. If no server connection was defined when the
|
||||
class was created a defualt Syslog connector will be used.
|
||||
class was created a default Syslog connector will be used.
|
||||
</div>
|
||||
|
||||
|
||||
@ -5177,7 +5177,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
|
||||
<td class="description last">The unformated Syslog message to send</td>
|
||||
<td class="description last">The unformatted Syslog message to send</td>
|
||||
</tr>
|
||||
|
||||
|
||||
@ -5230,7 +5230,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
A Syslog formated string acording to the selected RFC
|
||||
A Syslog formatted string according to the selected RFC
|
||||
</div>
|
||||
|
||||
|
||||
@ -5267,7 +5267,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1201">line 1201</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1200">line 1200</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -5688,7 +5688,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1614">line 1614</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1613">line 1613</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -5728,7 +5728,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 4 (Warning)
|
||||
Send a syslog message with a severity level of 4 (Warning)
|
||||
</div>
|
||||
|
||||
|
||||
@ -5807,7 +5807,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -5835,7 +5835,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -5872,7 +5872,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
<dt class="tag-source">Source:</dt>
|
||||
<dd class="tag-source"><ul class="dummy"><li>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1601">line 1601</a>
|
||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1600">line 1600</a>
|
||||
</li></ul></dd>
|
||||
|
||||
|
||||
@ -5912,7 +5912,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="description">
|
||||
Send a syslog message with a secerity level of 4 (Warning)
|
||||
Send a syslog message with a severity level of 4 (Warning)
|
||||
</div>
|
||||
|
||||
|
||||
@ -5991,7 +5991,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<dl>
|
||||
<dt>
|
||||
<div class="param-desc">
|
||||
- Any bubbled up error
|
||||
- Any bubbled-up error
|
||||
</div>
|
||||
</dt>
|
||||
<dd></dd>
|
||||
@ -6019,7 +6019,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
|
||||
|
||||
<div class="param-desc">
|
||||
- The formated syslog message sent to the Syslog server
|
||||
- The formatted syslog message sent to the Syslog server
|
||||
</div>
|
||||
|
||||
|
||||
@ -6059,7 +6059,7 @@ fashion where new messages are writen to the class as needed.</div>
|
||||
<br class="clear">
|
||||
|
||||
<footer>
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Sep 25 2018 18:22:00 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Tue Sep 25 2018 19:11:53 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
|
||||
</footer>
|
||||
|
||||
<script>prettyPrint();</script>
|
||||
|
Reference in New Issue
Block a user