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

updated documents

Browse Source
This commit is contained in:
Craig Yamato
2018-09-25 19:12:40 +00:00
parent eb3d0b5470
commit 1b83a3e15d
14 changed files with 1292 additions and 1316 deletions
Download Patch File Download Diff File Expand all files Collapse all files

10
docs/index.html
View File

@ -81,8 +81,8 @@ and the <a href="https://nodejs.org/api/dns.html#dns_dns_promises_api">DNS Promi
protocol: 'udp',
format: 'rfc5424'
});
syslog.rfc5424.info('My Message');</code></pre><p> Optionaly you can create each class or class options to pass to SyslogPro
to create formated messages or use directly</p>
syslog.rfc5424.info('My Message');</code></pre><p>Optionally you can create each class or class options to pass to SyslogPro to
create formatted messages or use directly</p>
<p><strong>RFC3164</strong></p>
<pre class="prettyprint source lang-js"><code> let rfc3164 = new SyslogPro.RFC3164({
applacationName: 'MyApp',
@ -142,7 +142,9 @@ and the <a href="https://nodejs.org/api/dns.html#dns_dns_promises_api">DNS Promi
});</code></pre><h2>API</h2><p>For more details see:</p>
<ul>
<li><a href="https://cyamato.github.io/SyslogPro/">JSDoc</a> </li>
<li><a href="./docs/api.md">api.md</a></li>
<li><a href="./docs/api.md">API.md</a></li>
<li><a href="./docs/docco/index.html">Docco.html</a></li>
<li><a href="./docs/docco/README.md">Docco.md</a></li>
</ul>
<h2>Test</h2><pre class="prettyprint source lang-shell"><code> npm test</code></pre><h2>Contributing</h2><p>Please try to maintain the existing coding style. Add unit tests for any new or
changed functionality. Lint and test your code.</p>
@ -165,7 +167,7 @@ changed functionality. Lint and test your code.</p>
<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>