sim1222/SyslogPro
1
0
Fork 0
mirror of https://github.com/misskey-dev/SyslogPro.git synced 2025-08-06 16:14:07 +09:00
Code Issues Packages Projects Releases Wiki Activity

Updated Readme

Browse Source
This commit is contained in:
Craig Yamato
2018-09-25 18:23:58 +00:00
parent b6a4870f1b
commit 00b72a3f57
28 changed files with 8448 additions and 253 deletions
Download Patch File Download Diff File Expand all files Collapse all files

89
docs/module-SyslogPro-RFC5424.html
View File

@ -49,7 +49,18 @@
RFC5424
</h2>
<div class="class-description">A class to work with RFC5424 formated syslog messages.</div>
<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.
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.
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>
</header>
@ -76,7 +87,7 @@
<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#line999">line 999</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1028">line 1028</a>
</li></ul></dd>
@ -1062,7 +1073,7 @@
<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#line1116">line 1116</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1145">line 1145</a>
</li></ul></dd>
@ -1121,7 +1132,7 @@
<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#line1094">line 1094</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1123">line 1123</a>
</li></ul></dd>
@ -1190,7 +1201,7 @@
<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#line1052">line 1052</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1081">line 1081</a>
</li></ul></dd>
@ -1249,7 +1260,7 @@
<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#line1118">line 1118</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1147">line 1147</a>
</li></ul></dd>
@ -1308,7 +1319,7 @@
<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#line1128">line 1128</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1157">line 1157</a>
</li></ul></dd>
@ -1367,7 +1378,7 @@
<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#line1114">line 1114</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1143">line 1143</a>
</li></ul></dd>
@ -1426,7 +1437,7 @@
<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#line1082">line 1082</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1111">line 1111</a>
</li></ul></dd>
@ -1495,7 +1506,7 @@
<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#line1120">line 1120</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1149">line 1149</a>
</li></ul></dd>
@ -1554,7 +1565,7 @@
<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#line1100">line 1100</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1129">line 1129</a>
</li></ul></dd>
@ -1623,7 +1634,7 @@
<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#line1126">line 1126</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1155">line 1155</a>
</li></ul></dd>
@ -1682,7 +1693,7 @@
<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#line1124">line 1124</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1153">line 1153</a>
</li></ul></dd>
@ -1741,7 +1752,7 @@
<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#line1107">line 1107</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1136">line 1136</a>
</li></ul></dd>
@ -1800,7 +1811,7 @@
<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#line1058">line 1058</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1087">line 1087</a>
</li></ul></dd>
@ -1869,7 +1880,7 @@
<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#line1076">line 1076</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1105">line 1105</a>
</li></ul></dd>
@ -1938,7 +1949,7 @@
<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#line1070">line 1070</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1099">line 1099</a>
</li></ul></dd>
@ -2007,7 +2018,7 @@
<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#line1064">line 1064</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1093">line 1093</a>
</li></ul></dd>
@ -2076,7 +2087,7 @@
<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#line1088">line 1088</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1117">line 1117</a>
</li></ul></dd>
@ -2145,7 +2156,7 @@
<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#line1122">line 1122</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1151">line 1151</a>
</li></ul></dd>
@ -2214,7 +2225,7 @@
<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#line1513">line 1513</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1542">line 1542</a>
</li></ul></dd>
@ -2398,7 +2409,7 @@
<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#line1332">line 1332</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1361">line 1361</a>
</li></ul></dd>
@ -2855,7 +2866,7 @@
<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#line1539">line 1539</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1568">line 1568</a>
</li></ul></dd>
@ -3039,7 +3050,7 @@
<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#line1526">line 1526</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1555">line 1555</a>
</li></ul></dd>
@ -3223,7 +3234,7 @@
<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#line1651">line 1651</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1680">line 1680</a>
</li></ul></dd>
@ -3407,7 +3418,7 @@
<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#line1503">line 1503</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1532">line 1532</a>
</li></ul></dd>
@ -3591,7 +3602,7 @@
<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#line1490">line 1490</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1519">line 1519</a>
</li></ul></dd>
@ -3775,7 +3786,7 @@
<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#line1562">line 1562</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1591">line 1591</a>
</li></ul></dd>
@ -3959,7 +3970,7 @@
<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#line1549">line 1549</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1578">line 1578</a>
</li></ul></dd>
@ -4143,7 +4154,7 @@
<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#line1631">line 1631</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1660">line 1660</a>
</li></ul></dd>
@ -4327,7 +4338,7 @@
<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#line1618">line 1618</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1647">line 1647</a>
</li></ul></dd>
@ -4511,7 +4522,7 @@
<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#line1641">line 1641</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1670">line 1670</a>
</li></ul></dd>
@ -4695,7 +4706,7 @@
<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#line1608">line 1608</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1637">line 1637</a>
</li></ul></dd>
@ -4879,7 +4890,7 @@
<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#line1595">line 1595</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1624">line 1624</a>
</li></ul></dd>
@ -5063,7 +5074,7 @@
<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#line1463">line 1463</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1492">line 1492</a>
</li></ul></dd>
@ -5256,7 +5267,7 @@
<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#line1172">line 1172</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1201">line 1201</a>
</li></ul></dd>
@ -5677,7 +5688,7 @@
<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#line1585">line 1585</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1614">line 1614</a>
</li></ul></dd>
@ -5861,7 +5872,7 @@
<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#line1572">line 1572</a>
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1601">line 1601</a>
</li></ul></dd>
@ -6048,7 +6059,7 @@
<br class="clear">
<footer>
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 24 2018 06:41:35 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 18:22:00 GMT+0000 (Coordinated Universal Time) using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
</footer>
<script>prettyPrint();</script>