mirror of
https://github.com/misskey-dev/SyslogPro.git
synced 2025-04-29 02:37:18 +09:00
Updated Readme
This commit is contained in:
Craig Yamato
parent
b6a4870f1b
commit
00b72a3f57
24
README.md
24
README.md
@ -18,10 +18,18 @@ Structured Data is also included in the module. All 28 standard CEF Extensions
|
|||||||
are included in the default CEF class. All 45 standard LEEF Attributes are
|
are included in the default CEF class. All 45 standard LEEF Attributes are
|
||||||
included in the default LEEF class. It is the goal of this project is for
|
included in the default LEEF class. It is the goal of this project is for
|
||||||
every release to offer full code coverage unit testing and documentation.
|
every release to offer full code coverage unit testing and documentation.
|
||||||
[Please see the full documentation for usage and options:
|
|
||||||
|
[Please see the full JSDoc for usage and options:
|
||||||
https://cyamato.github.io/SyslogPro/](https://cyamato.github.io/SyslogPro/).
|
https://cyamato.github.io/SyslogPro/](https://cyamato.github.io/SyslogPro/).
|
||||||
|
|
||||||
## Installation
|
### News
|
||||||
|
* ⚠ Please note that at present, the 0.1.x version of the SDK
|
||||||
|
[requires Node 10.6 or later](https://github.com/nodejs/LTS).
|
||||||
|
* This module makes use of [ECMA-262 Promise](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise)
|
||||||
|
and the [DNS Promises API](https://nodejs.org/api/dns.html#dns_dns_promises_api).
|
||||||
|
* APIs do not support the callback model and only return promises.
|
||||||
|
|
||||||
|
### Installation
|
||||||
```shell
|
```shell
|
||||||
npm install --save SyslogPro
|
npm install --save SyslogPro
|
||||||
```
|
```
|
||||||
@ -111,6 +119,11 @@ https://cyamato.github.io/SyslogPro/](https://cyamato.github.io/SyslogPro/).
|
|||||||
});
|
});
|
||||||
```
|
```
|
||||||
|
|
||||||
|
## API
|
||||||
|
For more details see:
|
||||||
|
* [JSDoc](https://cyamato.github.io/SyslogPro/)
|
||||||
|
* [api.md](./docs/api.md)
|
||||||
|
|
||||||
## Test
|
## Test
|
||||||
```shell
|
```shell
|
||||||
npm test
|
npm test
|
||||||
@ -118,4 +131,9 @@ https://cyamato.github.io/SyslogPro/](https://cyamato.github.io/SyslogPro/).
|
|||||||
|
|
||||||
## Contributing
|
## Contributing
|
||||||
|
|
||||||
Please try to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.
|
Please try to maintain the existing coding style. Add unit tests for any new or
|
||||||
|
changed functionality. Lint and test your code.
|
||||||
|
|
||||||
|
* [Repository](https://github.com/cyamato/SyslogPro.git)
|
||||||
|
* [Bug Reporting](https://github.com/cyamato/SyslogPro/issues)
|
||||||
|
* [Wiki](https://github.com/cyamato/SyslogPro/wiki)
|
||||||
1257
docs/api.md
Normal file
1257
docs/api.md
Normal file
File diff suppressed because it is too large
Load Diff
2699
docs/docco/README.md
Normal file
2699
docs/docco/README.md
Normal file
File diff suppressed because it is too large
Load Diff
518
docs/docco/docco.css
Normal file
518
docs/docco/docco.css
Normal file
@ -0,0 +1,518 @@
|
|||||||
|
/*--------------------- Typography ----------------------------*/
|
||||||
|
|
||||||
|
@font-face {
|
||||||
|
font-family: 'aller-light';
|
||||||
|
src: url('public/fonts/aller-light.eot');
|
||||||
|
src: url('public/fonts/aller-light.eot?#iefix') format('embedded-opentype'),
|
||||||
|
url('public/fonts/aller-light.woff') format('woff'),
|
||||||
|
url('public/fonts/aller-light.ttf') format('truetype');
|
||||||
|
font-weight: normal;
|
||||||
|
font-style: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
@font-face {
|
||||||
|
font-family: 'aller-bold';
|
||||||
|
src: url('public/fonts/aller-bold.eot');
|
||||||
|
src: url('public/fonts/aller-bold.eot?#iefix') format('embedded-opentype'),
|
||||||
|
url('public/fonts/aller-bold.woff') format('woff'),
|
||||||
|
url('public/fonts/aller-bold.ttf') format('truetype');
|
||||||
|
font-weight: normal;
|
||||||
|
font-style: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
@font-face {
|
||||||
|
font-family: 'roboto-black';
|
||||||
|
src: url('public/fonts/roboto-black.eot');
|
||||||
|
src: url('public/fonts/roboto-black.eot?#iefix') format('embedded-opentype'),
|
||||||
|
url('public/fonts/roboto-black.woff') format('woff'),
|
||||||
|
url('public/fonts/roboto-black.ttf') format('truetype');
|
||||||
|
font-weight: normal;
|
||||||
|
font-style: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*--------------------- Layout ----------------------------*/
|
||||||
|
html { height: 100%; }
|
||||||
|
body {
|
||||||
|
font-family: "aller-light";
|
||||||
|
font-size: 14px;
|
||||||
|
line-height: 18px;
|
||||||
|
color: #30404f;
|
||||||
|
margin: 0; padding: 0;
|
||||||
|
height:100%;
|
||||||
|
}
|
||||||
|
#container { min-height: 100%; }
|
||||||
|
|
||||||
|
a {
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
|
||||||
|
b, strong {
|
||||||
|
font-weight: normal;
|
||||||
|
font-family: "aller-bold";
|
||||||
|
}
|
||||||
|
|
||||||
|
p {
|
||||||
|
margin: 15px 0 0px;
|
||||||
|
}
|
||||||
|
.annotation ul, .annotation ol {
|
||||||
|
margin: 25px 0;
|
||||||
|
}
|
||||||
|
.annotation ul li, .annotation ol li {
|
||||||
|
font-size: 14px;
|
||||||
|
line-height: 18px;
|
||||||
|
margin: 10px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1, h2, h3, h4, h5, h6 {
|
||||||
|
color: #112233;
|
||||||
|
line-height: 1em;
|
||||||
|
font-weight: normal;
|
||||||
|
font-family: "roboto-black";
|
||||||
|
text-transform: uppercase;
|
||||||
|
margin: 30px 0 15px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
margin-top: 40px;
|
||||||
|
}
|
||||||
|
h2 {
|
||||||
|
font-size: 1.26em;
|
||||||
|
}
|
||||||
|
|
||||||
|
hr {
|
||||||
|
border: 0;
|
||||||
|
background: 1px #ddd;
|
||||||
|
height: 1px;
|
||||||
|
margin: 20px 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre, tt, code {
|
||||||
|
font-size: 12px; line-height: 16px;
|
||||||
|
font-family: Menlo, Monaco, Consolas, "Lucida Console", monospace;
|
||||||
|
margin: 0; padding: 0;
|
||||||
|
}
|
||||||
|
.annotation pre {
|
||||||
|
display: block;
|
||||||
|
margin: 0;
|
||||||
|
padding: 7px 10px;
|
||||||
|
background: #fcfcfc;
|
||||||
|
-moz-box-shadow: inset 0 0 10px rgba(0,0,0,0.1);
|
||||||
|
-webkit-box-shadow: inset 0 0 10px rgba(0,0,0,0.1);
|
||||||
|
box-shadow: inset 0 0 10px rgba(0,0,0,0.1);
|
||||||
|
overflow-x: auto;
|
||||||
|
}
|
||||||
|
.annotation pre code {
|
||||||
|
border: 0;
|
||||||
|
padding: 0;
|
||||||
|
background: transparent;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
blockquote {
|
||||||
|
border-left: 5px solid #ccc;
|
||||||
|
margin: 0;
|
||||||
|
padding: 1px 0 1px 1em;
|
||||||
|
}
|
||||||
|
.sections blockquote p {
|
||||||
|
font-family: Menlo, Consolas, Monaco, monospace;
|
||||||
|
font-size: 12px; line-height: 16px;
|
||||||
|
color: #999;
|
||||||
|
margin: 10px 0 0;
|
||||||
|
white-space: pre-wrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections {
|
||||||
|
list-style: none;
|
||||||
|
padding:0 0 5px 0;;
|
||||||
|
margin:0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
Force border-box so that % widths fit the parent
|
||||||
|
container without overlap because of margin/padding.
|
||||||
|
|
||||||
|
More Info : http://www.quirksmode.org/css/box.html
|
||||||
|
*/
|
||||||
|
ul.sections > li > div {
|
||||||
|
-moz-box-sizing: border-box; /* firefox */
|
||||||
|
-ms-box-sizing: border-box; /* ie */
|
||||||
|
-webkit-box-sizing: border-box; /* webkit */
|
||||||
|
-khtml-box-sizing: border-box; /* konqueror */
|
||||||
|
box-sizing: border-box; /* css3 */
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/*---------------------- Jump Page -----------------------------*/
|
||||||
|
#jump_to, #jump_page {
|
||||||
|
margin: 0;
|
||||||
|
background: white;
|
||||||
|
-webkit-box-shadow: 0 0 25px #777; -moz-box-shadow: 0 0 25px #777;
|
||||||
|
-webkit-border-bottom-left-radius: 5px; -moz-border-radius-bottomleft: 5px;
|
||||||
|
font: 16px Arial;
|
||||||
|
cursor: pointer;
|
||||||
|
text-align: right;
|
||||||
|
list-style: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#jump_to a {
|
||||||
|
text-decoration: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
#jump_to a.large {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
#jump_to a.small {
|
||||||
|
font-size: 22px;
|
||||||
|
font-weight: bold;
|
||||||
|
color: #676767;
|
||||||
|
}
|
||||||
|
|
||||||
|
#jump_to, #jump_wrapper {
|
||||||
|
position: fixed;
|
||||||
|
right: 0; top: 0;
|
||||||
|
padding: 10px 15px;
|
||||||
|
margin:0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#jump_wrapper {
|
||||||
|
display: none;
|
||||||
|
padding:0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#jump_to:hover #jump_wrapper {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
#jump_page_wrapper{
|
||||||
|
position: fixed;
|
||||||
|
right: 0;
|
||||||
|
top: 0;
|
||||||
|
bottom: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
#jump_page {
|
||||||
|
padding: 5px 0 3px;
|
||||||
|
margin: 0 0 25px 25px;
|
||||||
|
max-height: 100%;
|
||||||
|
overflow: auto;
|
||||||
|
}
|
||||||
|
|
||||||
|
#jump_page .source {
|
||||||
|
display: block;
|
||||||
|
padding: 15px;
|
||||||
|
text-decoration: none;
|
||||||
|
border-top: 1px solid #eee;
|
||||||
|
}
|
||||||
|
|
||||||
|
#jump_page .source:hover {
|
||||||
|
background: #f5f5ff;
|
||||||
|
}
|
||||||
|
|
||||||
|
#jump_page .source:first-child {
|
||||||
|
}
|
||||||
|
|
||||||
|
/*---------------------- Low resolutions (> 320px) ---------------------*/
|
||||||
|
@media only screen and (min-width: 320px) {
|
||||||
|
.pilwrap { display: none; }
|
||||||
|
|
||||||
|
ul.sections > li > div {
|
||||||
|
display: block;
|
||||||
|
padding:5px 10px 0 10px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections > li > div.annotation ul, ul.sections > li > div.annotation ol {
|
||||||
|
padding-left: 30px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections > li > div.content {
|
||||||
|
overflow-x:auto;
|
||||||
|
-webkit-box-shadow: inset 0 0 5px #e5e5ee;
|
||||||
|
box-shadow: inset 0 0 5px #e5e5ee;
|
||||||
|
border: 1px solid #dedede;
|
||||||
|
margin:5px 10px 5px 10px;
|
||||||
|
padding-bottom: 5px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections > li > div.annotation pre {
|
||||||
|
margin: 7px 0 7px;
|
||||||
|
padding-left: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections > li > div.annotation p tt, .annotation code {
|
||||||
|
background: #f8f8ff;
|
||||||
|
border: 1px solid #dedede;
|
||||||
|
font-size: 12px;
|
||||||
|
padding: 0 0.2em;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/*---------------------- (> 481px) ---------------------*/
|
||||||
|
@media only screen and (min-width: 481px) {
|
||||||
|
#container {
|
||||||
|
position: relative;
|
||||||
|
}
|
||||||
|
body {
|
||||||
|
background-color: #F5F5FF;
|
||||||
|
font-size: 15px;
|
||||||
|
line-height: 21px;
|
||||||
|
}
|
||||||
|
pre, tt, code {
|
||||||
|
line-height: 18px;
|
||||||
|
}
|
||||||
|
p, ul, ol {
|
||||||
|
margin: 0 0 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
#jump_to {
|
||||||
|
padding: 5px 10px;
|
||||||
|
}
|
||||||
|
#jump_wrapper {
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
#jump_to, #jump_page {
|
||||||
|
font: 10px Arial;
|
||||||
|
text-transform: uppercase;
|
||||||
|
}
|
||||||
|
#jump_page .source {
|
||||||
|
padding: 5px 10px;
|
||||||
|
}
|
||||||
|
#jump_to a.large {
|
||||||
|
display: inline-block;
|
||||||
|
}
|
||||||
|
#jump_to a.small {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
#background {
|
||||||
|
position: absolute;
|
||||||
|
top: 0; bottom: 0;
|
||||||
|
width: 350px;
|
||||||
|
background: #fff;
|
||||||
|
border-right: 1px solid #e5e5ee;
|
||||||
|
z-index: -1;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections > li > div.annotation ul, ul.sections > li > div.annotation ol {
|
||||||
|
padding-left: 40px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections > li {
|
||||||
|
white-space: nowrap;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections > li > div {
|
||||||
|
display: inline-block;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections > li > div.annotation {
|
||||||
|
max-width: 350px;
|
||||||
|
min-width: 350px;
|
||||||
|
min-height: 5px;
|
||||||
|
padding: 13px;
|
||||||
|
overflow-x: hidden;
|
||||||
|
white-space: normal;
|
||||||
|
vertical-align: top;
|
||||||
|
text-align: left;
|
||||||
|
}
|
||||||
|
ul.sections > li > div.annotation pre {
|
||||||
|
margin: 15px 0 15px;
|
||||||
|
padding-left: 15px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections > li > div.content {
|
||||||
|
padding: 13px;
|
||||||
|
vertical-align: top;
|
||||||
|
border: none;
|
||||||
|
-webkit-box-shadow: none;
|
||||||
|
box-shadow: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
.pilwrap {
|
||||||
|
position: relative;
|
||||||
|
display: inline;
|
||||||
|
}
|
||||||
|
|
||||||
|
.pilcrow {
|
||||||
|
font: 12px Arial;
|
||||||
|
text-decoration: none;
|
||||||
|
color: #454545;
|
||||||
|
position: absolute;
|
||||||
|
top: 3px; left: -20px;
|
||||||
|
padding: 1px 2px;
|
||||||
|
opacity: 0;
|
||||||
|
-webkit-transition: opacity 0.2s linear;
|
||||||
|
}
|
||||||
|
.for-h1 .pilcrow {
|
||||||
|
top: 47px;
|
||||||
|
}
|
||||||
|
.for-h2 .pilcrow, .for-h3 .pilcrow, .for-h4 .pilcrow {
|
||||||
|
top: 35px;
|
||||||
|
}
|
||||||
|
|
||||||
|
ul.sections > li > div.annotation:hover .pilcrow {
|
||||||
|
opacity: 1;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/*---------------------- (> 1025px) ---------------------*/
|
||||||
|
@media only screen and (min-width: 1025px) {
|
||||||
|
|
||||||
|
body {
|
||||||
|
font-size: 16px;
|
||||||
|
line-height: 24px;
|
||||||
|
}
|
||||||
|
|
||||||
|
#background {
|
||||||
|
width: 525px;
|
||||||
|
}
|
||||||
|
ul.sections > li > div.annotation {
|
||||||
|
max-width: 525px;
|
||||||
|
min-width: 525px;
|
||||||
|
padding: 10px 25px 1px 50px;
|
||||||
|
}
|
||||||
|
ul.sections > li > div.content {
|
||||||
|
padding: 9px 15px 16px 25px;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
/*---------------------- Syntax Highlighting -----------------------------*/
|
||||||
|
|
||||||
|
td.linenos { background-color: #f0f0f0; padding-right: 10px; }
|
||||||
|
span.lineno { background-color: #f0f0f0; padding: 0 5px 0 5px; }
|
||||||
|
/*
|
||||||
|
|
||||||
|
github.com style (c) Vasily Polovnyov <vast@whiteants.net>
|
||||||
|
|
||||||
|
*/
|
||||||
|
|
||||||
|
pre code {
|
||||||
|
display: block; padding: 0.5em;
|
||||||
|
color: #000;
|
||||||
|
background: #f8f8ff
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-comment,
|
||||||
|
pre .hljs-template_comment,
|
||||||
|
pre .hljs-diff .hljs-header,
|
||||||
|
pre .hljs-javadoc {
|
||||||
|
color: #408080;
|
||||||
|
font-style: italic
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-keyword,
|
||||||
|
pre .hljs-assignment,
|
||||||
|
pre .hljs-literal,
|
||||||
|
pre .hljs-css .hljs-rule .hljs-keyword,
|
||||||
|
pre .hljs-winutils,
|
||||||
|
pre .hljs-javascript .hljs-title,
|
||||||
|
pre .hljs-lisp .hljs-title,
|
||||||
|
pre .hljs-subst {
|
||||||
|
color: #954121;
|
||||||
|
/*font-weight: bold*/
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-number,
|
||||||
|
pre .hljs-hexcolor {
|
||||||
|
color: #40a070
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-string,
|
||||||
|
pre .hljs-tag .hljs-value,
|
||||||
|
pre .hljs-phpdoc,
|
||||||
|
pre .hljs-tex .hljs-formula {
|
||||||
|
color: #219161;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-title,
|
||||||
|
pre .hljs-id {
|
||||||
|
color: #19469D;
|
||||||
|
}
|
||||||
|
pre .hljs-params {
|
||||||
|
color: #00F;
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-javascript .hljs-title,
|
||||||
|
pre .hljs-lisp .hljs-title,
|
||||||
|
pre .hljs-subst {
|
||||||
|
font-weight: normal
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-class .hljs-title,
|
||||||
|
pre .hljs-haskell .hljs-label,
|
||||||
|
pre .hljs-tex .hljs-command {
|
||||||
|
color: #458;
|
||||||
|
font-weight: bold
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-tag,
|
||||||
|
pre .hljs-tag .hljs-title,
|
||||||
|
pre .hljs-rules .hljs-property,
|
||||||
|
pre .hljs-django .hljs-tag .hljs-keyword {
|
||||||
|
color: #000080;
|
||||||
|
font-weight: normal
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-attribute,
|
||||||
|
pre .hljs-variable,
|
||||||
|
pre .hljs-instancevar,
|
||||||
|
pre .hljs-lisp .hljs-body {
|
||||||
|
color: #008080
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-regexp {
|
||||||
|
color: #B68
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-class {
|
||||||
|
color: #458;
|
||||||
|
font-weight: bold
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-symbol,
|
||||||
|
pre .hljs-ruby .hljs-symbol .hljs-string,
|
||||||
|
pre .hljs-ruby .hljs-symbol .hljs-keyword,
|
||||||
|
pre .hljs-ruby .hljs-symbol .hljs-keymethods,
|
||||||
|
pre .hljs-lisp .hljs-keyword,
|
||||||
|
pre .hljs-tex .hljs-special,
|
||||||
|
pre .hljs-input_number {
|
||||||
|
color: #990073
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-builtin,
|
||||||
|
pre .hljs-constructor,
|
||||||
|
pre .hljs-built_in,
|
||||||
|
pre .hljs-lisp .hljs-title {
|
||||||
|
color: #0086b3
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-preprocessor,
|
||||||
|
pre .hljs-pi,
|
||||||
|
pre .hljs-doctype,
|
||||||
|
pre .hljs-shebang,
|
||||||
|
pre .hljs-cdata {
|
||||||
|
color: #999;
|
||||||
|
font-weight: bold
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-deletion {
|
||||||
|
background: #fdd
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-addition {
|
||||||
|
background: #dfd
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-diff .hljs-change {
|
||||||
|
background: #0086b3
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-chunk {
|
||||||
|
color: #aaa
|
||||||
|
}
|
||||||
|
|
||||||
|
pre .hljs-tex .hljs-formula {
|
||||||
|
opacity: 0.5;
|
||||||
|
}
|
||||||
2699
docs/docco/index.html
Normal file
2699
docs/docco/index.html
Normal file
File diff suppressed because it is too large
Load Diff
BIN
docs/docco/public/fonts/aller-bold.eot
Normal file
BIN
docs/docco/public/fonts/aller-bold.eot
Normal file
Binary file not shown.
BIN
docs/docco/public/fonts/aller-bold.ttf
Normal file
BIN
docs/docco/public/fonts/aller-bold.ttf
Normal file
Binary file not shown.
BIN
docs/docco/public/fonts/aller-bold.woff
Normal file
BIN
docs/docco/public/fonts/aller-bold.woff
Normal file
Binary file not shown.
BIN
docs/docco/public/fonts/aller-light.eot
Normal file
BIN
docs/docco/public/fonts/aller-light.eot
Normal file
Binary file not shown.
BIN
docs/docco/public/fonts/aller-light.ttf
Normal file
BIN
docs/docco/public/fonts/aller-light.ttf
Normal file
Binary file not shown.
BIN
docs/docco/public/fonts/aller-light.woff
Normal file
BIN
docs/docco/public/fonts/aller-light.woff
Normal file
Binary file not shown.
BIN
docs/docco/public/fonts/roboto-black.eot
Executable file
BIN
docs/docco/public/fonts/roboto-black.eot
Executable file
Binary file not shown.
BIN
docs/docco/public/fonts/roboto-black.ttf
Executable file
BIN
docs/docco/public/fonts/roboto-black.ttf
Executable file
Binary file not shown.
BIN
docs/docco/public/fonts/roboto-black.woff
Executable file
BIN
docs/docco/public/fonts/roboto-black.woff
Executable file
Binary file not shown.
375
docs/docco/public/stylesheets/normalize.css
vendored
Normal file
375
docs/docco/public/stylesheets/normalize.css
vendored
Normal file
@ -0,0 +1,375 @@
|
|||||||
|
/*! normalize.css v2.0.1 | MIT License | git.io/normalize */
|
||||||
|
|
||||||
|
/* ==========================================================================
|
||||||
|
HTML5 display definitions
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Corrects `block` display not defined in IE 8/9.
|
||||||
|
*/
|
||||||
|
|
||||||
|
article,
|
||||||
|
aside,
|
||||||
|
details,
|
||||||
|
figcaption,
|
||||||
|
figure,
|
||||||
|
footer,
|
||||||
|
header,
|
||||||
|
hgroup,
|
||||||
|
nav,
|
||||||
|
section,
|
||||||
|
summary {
|
||||||
|
display: block;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Corrects `inline-block` display not defined in IE 8/9.
|
||||||
|
*/
|
||||||
|
|
||||||
|
audio,
|
||||||
|
canvas,
|
||||||
|
video {
|
||||||
|
display: inline-block;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Prevents modern browsers from displaying `audio` without controls.
|
||||||
|
* Remove excess height in iOS 5 devices.
|
||||||
|
*/
|
||||||
|
|
||||||
|
audio:not([controls]) {
|
||||||
|
display: none;
|
||||||
|
height: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Addresses styling for `hidden` attribute not present in IE 8/9.
|
||||||
|
*/
|
||||||
|
|
||||||
|
[hidden] {
|
||||||
|
display: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ==========================================================================
|
||||||
|
Base
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* 1. Sets default font family to sans-serif.
|
||||||
|
* 2. Prevents iOS text size adjust after orientation change, without disabling
|
||||||
|
* user zoom.
|
||||||
|
*/
|
||||||
|
|
||||||
|
html {
|
||||||
|
font-family: sans-serif; /* 1 */
|
||||||
|
-webkit-text-size-adjust: 100%; /* 2 */
|
||||||
|
-ms-text-size-adjust: 100%; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Removes default margin.
|
||||||
|
*/
|
||||||
|
|
||||||
|
body {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ==========================================================================
|
||||||
|
Links
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Addresses `outline` inconsistency between Chrome and other browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
a:focus {
|
||||||
|
outline: thin dotted;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Improves readability when focused and also mouse hovered in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
a:active,
|
||||||
|
a:hover {
|
||||||
|
outline: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ==========================================================================
|
||||||
|
Typography
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Addresses `h1` font sizes within `section` and `article` in Firefox 4+,
|
||||||
|
* Safari 5, and Chrome.
|
||||||
|
*/
|
||||||
|
|
||||||
|
h1 {
|
||||||
|
font-size: 2em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Addresses styling not present in IE 8/9, Safari 5, and Chrome.
|
||||||
|
*/
|
||||||
|
|
||||||
|
abbr[title] {
|
||||||
|
border-bottom: 1px dotted;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Addresses style set to `bolder` in Firefox 4+, Safari 5, and Chrome.
|
||||||
|
*/
|
||||||
|
|
||||||
|
b,
|
||||||
|
strong {
|
||||||
|
font-weight: bold;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Addresses styling not present in Safari 5 and Chrome.
|
||||||
|
*/
|
||||||
|
|
||||||
|
dfn {
|
||||||
|
font-style: italic;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Addresses styling not present in IE 8/9.
|
||||||
|
*/
|
||||||
|
|
||||||
|
mark {
|
||||||
|
background: #ff0;
|
||||||
|
color: #000;
|
||||||
|
}
|
||||||
|
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Corrects font family set oddly in Safari 5 and Chrome.
|
||||||
|
*/
|
||||||
|
|
||||||
|
code,
|
||||||
|
kbd,
|
||||||
|
pre,
|
||||||
|
samp {
|
||||||
|
font-family: monospace, serif;
|
||||||
|
font-size: 1em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Improves readability of pre-formatted text in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
pre {
|
||||||
|
white-space: pre;
|
||||||
|
white-space: pre-wrap;
|
||||||
|
word-wrap: break-word;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Sets consistent quote types.
|
||||||
|
*/
|
||||||
|
|
||||||
|
q {
|
||||||
|
quotes: "\201C" "\201D" "\2018" "\2019";
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Addresses inconsistent and variable font size in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
small {
|
||||||
|
font-size: 80%;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Prevents `sub` and `sup` affecting `line-height` in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
sub,
|
||||||
|
sup {
|
||||||
|
font-size: 75%;
|
||||||
|
line-height: 0;
|
||||||
|
position: relative;
|
||||||
|
vertical-align: baseline;
|
||||||
|
}
|
||||||
|
|
||||||
|
sup {
|
||||||
|
top: -0.5em;
|
||||||
|
}
|
||||||
|
|
||||||
|
sub {
|
||||||
|
bottom: -0.25em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ==========================================================================
|
||||||
|
Embedded content
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Removes border when inside `a` element in IE 8/9.
|
||||||
|
*/
|
||||||
|
|
||||||
|
img {
|
||||||
|
border: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Corrects overflow displayed oddly in IE 9.
|
||||||
|
*/
|
||||||
|
|
||||||
|
svg:not(:root) {
|
||||||
|
overflow: hidden;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ==========================================================================
|
||||||
|
Figures
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Addresses margin not present in IE 8/9 and Safari 5.
|
||||||
|
*/
|
||||||
|
|
||||||
|
figure {
|
||||||
|
margin: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ==========================================================================
|
||||||
|
Forms
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Define consistent border, margin, and padding.
|
||||||
|
*/
|
||||||
|
|
||||||
|
fieldset {
|
||||||
|
border: 1px solid #c0c0c0;
|
||||||
|
margin: 0 2px;
|
||||||
|
padding: 0.35em 0.625em 0.75em;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* 1. Corrects color not being inherited in IE 8/9.
|
||||||
|
* 2. Remove padding so people aren't caught out if they zero out fieldsets.
|
||||||
|
*/
|
||||||
|
|
||||||
|
legend {
|
||||||
|
border: 0; /* 1 */
|
||||||
|
padding: 0; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* 1. Corrects font family not being inherited in all browsers.
|
||||||
|
* 2. Corrects font size not being inherited in all browsers.
|
||||||
|
* 3. Addresses margins set differently in Firefox 4+, Safari 5, and Chrome
|
||||||
|
*/
|
||||||
|
|
||||||
|
button,
|
||||||
|
input,
|
||||||
|
select,
|
||||||
|
textarea {
|
||||||
|
font-family: inherit; /* 1 */
|
||||||
|
font-size: 100%; /* 2 */
|
||||||
|
margin: 0; /* 3 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Addresses Firefox 4+ setting `line-height` on `input` using `!important` in
|
||||||
|
* the UA stylesheet.
|
||||||
|
*/
|
||||||
|
|
||||||
|
button,
|
||||||
|
input {
|
||||||
|
line-height: normal;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* 1. Avoid the WebKit bug in Android 4.0.* where (2) destroys native `audio`
|
||||||
|
* and `video` controls.
|
||||||
|
* 2. Corrects inability to style clickable `input` types in iOS.
|
||||||
|
* 3. Improves usability and consistency of cursor style between image-type
|
||||||
|
* `input` and others.
|
||||||
|
*/
|
||||||
|
|
||||||
|
button,
|
||||||
|
html input[type="button"], /* 1 */
|
||||||
|
input[type="reset"],
|
||||||
|
input[type="submit"] {
|
||||||
|
-webkit-appearance: button; /* 2 */
|
||||||
|
cursor: pointer; /* 3 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Re-set default cursor for disabled elements.
|
||||||
|
*/
|
||||||
|
|
||||||
|
button[disabled],
|
||||||
|
input[disabled] {
|
||||||
|
cursor: default;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* 1. Addresses box sizing set to `content-box` in IE 8/9.
|
||||||
|
* 2. Removes excess padding in IE 8/9.
|
||||||
|
*/
|
||||||
|
|
||||||
|
input[type="checkbox"],
|
||||||
|
input[type="radio"] {
|
||||||
|
box-sizing: border-box; /* 1 */
|
||||||
|
padding: 0; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* 1. Addresses `appearance` set to `searchfield` in Safari 5 and Chrome.
|
||||||
|
* 2. Addresses `box-sizing` set to `border-box` in Safari 5 and Chrome
|
||||||
|
* (include `-moz` to future-proof).
|
||||||
|
*/
|
||||||
|
|
||||||
|
input[type="search"] {
|
||||||
|
-webkit-appearance: textfield; /* 1 */
|
||||||
|
-moz-box-sizing: content-box;
|
||||||
|
-webkit-box-sizing: content-box; /* 2 */
|
||||||
|
box-sizing: content-box;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Removes inner padding and search cancel button in Safari 5 and Chrome
|
||||||
|
* on OS X.
|
||||||
|
*/
|
||||||
|
|
||||||
|
input[type="search"]::-webkit-search-cancel-button,
|
||||||
|
input[type="search"]::-webkit-search-decoration {
|
||||||
|
-webkit-appearance: none;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Removes inner padding and border in Firefox 4+.
|
||||||
|
*/
|
||||||
|
|
||||||
|
button::-moz-focus-inner,
|
||||||
|
input::-moz-focus-inner {
|
||||||
|
border: 0;
|
||||||
|
padding: 0;
|
||||||
|
}
|
||||||
|
|
||||||
|
/*
|
||||||
|
* 1. Removes default vertical scrollbar in IE 8/9.
|
||||||
|
* 2. Improves readability and alignment in all browsers.
|
||||||
|
*/
|
||||||
|
|
||||||
|
textarea {
|
||||||
|
overflow: auto; /* 1 */
|
||||||
|
vertical-align: top; /* 2 */
|
||||||
|
}
|
||||||
|
|
||||||
|
/* ==========================================================================
|
||||||
|
Tables
|
||||||
|
========================================================================== */
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Remove most spacing between table cells.
|
||||||
|
*/
|
||||||
|
|
||||||
|
table {
|
||||||
|
border-collapse: collapse;
|
||||||
|
border-spacing: 0;
|
||||||
|
}
|
||||||
@ -50,31 +50,41 @@
|
|||||||
|
|
||||||
|
|
||||||
<section class="readme">
|
<section class="readme">
|
||||||
<article><h1>SyslogPro</h1><p>A pure Javascript Syslog module with support for RFC3164, RFC5424, IBM LEEF
|
<article><h1>SyslogPro</h1><p><a href="https://travis-ci.org/cyamato/SyslogPro"><img src="https://travis-ci.org/cyamato/SyslogPro.svg?branch=master" alt="Build Status"></a>
|
||||||
|
<a href="https://coveralls.io/github/cyamato/SyslogPro?branch=master"><img src="https://coveralls.io/repos/github/cyamato/SyslogPro/badge.svg?branch=master" alt="Coverage Status"></a>
|
||||||
|
<img src="https://img.shields.io/dub/l/vibe-d.svg?style=flat" alt=""></p>
|
||||||
|
<p><a href="https://github.com/cyamato/SyslogPro">Site</a> |
|
||||||
|
<a href="https://cyamato.github.io/SyslogPro/">Docs</a> |
|
||||||
|
<a href="https://github.com/cyamato/SyslogPro/wiki" title="Changelog, Roadmap, etc.">Wiki</a> |
|
||||||
|
<a href="https://js.foundation/community/code-of-conduct">Code of Conduct</a></p>
|
||||||
|
<p>A pure Javascript Syslog module with support for RFC3164, RFC5424, IBM LEEF
|
||||||
(Log Event Extended Format), and HP CEF (Common Event Format) formatted
|
(Log Event Extended Format), and HP CEF (Common Event Format) formatted
|
||||||
messages. SyslogPro has transport options of UDP, TCP, and TLS. TLS includes
|
messages. SyslogPro has transport options for UDP, TCP, and TLS. TLS includes
|
||||||
support for Server and Client certificate authrization. For unformatedm and
|
support for Server and Client certificate authorization. For unformatted and
|
||||||
RFC messages there is support for Basic and Extended ANSI coloring. RFC5424
|
RFC messages there is support for Basic and Extended ANSI coloring. RFC5424
|
||||||
Strucutred Data is also encluded in the module. All 28 standard CEF Extentions
|
Structured Data is also included in the module. All 28 standard CEF Extensions
|
||||||
are included in the defualt CEF class. All 45 standard LEEF Atrabutes are
|
are included in the default CEF class. All 45 standard LEEF Attributes are
|
||||||
included in the defualt LEEF class. It is the goal of this project is for every
|
included in the default LEEF class. It is the goal of this project is for
|
||||||
relase to offer full code covrage unit testing and documentation. Please see
|
every release to offer full code coverage unit testing and documentation. </p>
|
||||||
the full documation for usage and options.</p>
|
<p><a href="https://cyamato.github.io/SyslogPro/">Please see the full JSDoc for usage and options:
|
||||||
<h2>Installation</h2><p> <code>npm install SyslogPro</code></p>
|
https://cyamato.github.io/SyslogPro/</a>.</p>
|
||||||
<h2>Usage</h2><pre class="prettyprint source"><code>const SyslogPro = require('syslogpro');
|
<h3>News</h3><ul>
|
||||||
|
<li>⚠ Please note that at present, the 0.1.x version of the SDK
|
||||||
|
<a href="https://github.com/nodejs/LTS">requires Node 10.6 or later</a>. </li>
|
||||||
|
<li>This module makes use of <a href="https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Promise">ECMA-262 Promise</a>
|
||||||
|
and the <a href="https://nodejs.org/api/dns.html#dns_dns_promises_api">DNS Promises API</a>. </li>
|
||||||
|
<li>APIs do not support the callback model and only return promises.</li>
|
||||||
|
</ul>
|
||||||
|
<h3>Installation</h3><pre class="prettyprint source lang-shell"><code> npm install --save SyslogPro</code></pre><h2>Usage</h2><pre class="prettyprint source lang-js"><code> const SyslogPro = require('syslogpro');
|
||||||
let syslog = new SyslogPro.Syslog({
|
let syslog = new SyslogPro.Syslog({
|
||||||
target: 'localhost',
|
target: 'localhost',
|
||||||
protocol: 'udp',
|
protocol: 'udp',
|
||||||
format: 'rfc5424'
|
format: 'rfc5424'
|
||||||
});
|
});
|
||||||
|
syslog.rfc5424.info('My Message');</code></pre><p> Optionaly you can create each class or class options to pass to SyslogPro
|
||||||
syslog.rfc5424.info('My Message');
|
to create formated messages or use directly</p>
|
||||||
|
<p><strong>RFC3164</strong></p>
|
||||||
// Optionaly you can create each class or class options to pass to SyslogPro
|
<pre class="prettyprint source lang-js"><code> let rfc3164 = new SyslogPro.RFC3164({
|
||||||
// to create formated messages or use directly
|
|
||||||
|
|
||||||
let rfc3164 = new SyslogPro.RFC3164({
|
|
||||||
applacationName: 'MyApp',
|
applacationName: 'MyApp',
|
||||||
color: true,
|
color: true,
|
||||||
extendedColor: true,
|
extendedColor: true,
|
||||||
@ -82,10 +92,8 @@ let rfc3164 = new SyslogPro.RFC3164({
|
|||||||
target: 'myServer.fqdn'
|
target: 'myServer.fqdn'
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
rfc3164.info('My Message');</code></pre><p><strong>RFC5424</strong></p>
|
||||||
rfc3164.info('My Message');
|
<pre class="prettyprint source lang-js"><code> let rfc5424 = new SyslogPro.RFC5424({
|
||||||
|
|
||||||
let rfc5424 = new SyslogPro.RFC5424({
|
|
||||||
applacationName: 'MyApp',
|
applacationName: 'MyApp',
|
||||||
timestamp: true,
|
timestamp: true,
|
||||||
encludeStructuredData: true
|
encludeStructuredData: true
|
||||||
@ -95,10 +103,8 @@ let rfc5424 = new SyslogPro.RFC5424({
|
|||||||
target: 'myServer.fqdn'
|
target: 'myServer.fqdn'
|
||||||
}
|
}
|
||||||
});
|
});
|
||||||
|
rfc5424.info('My Message');</code></pre><p><strong>LEEF (Log Event Extended Format)</strong></p>
|
||||||
rfc5424.info('My Message');
|
<pre class="prettyprint source lang-js"><code> let leef = new SyslogPro.LEEF({
|
||||||
|
|
||||||
let leef = new SyslogPro.LEEF({
|
|
||||||
vendor: 'acme',
|
vendor: 'acme',
|
||||||
product: 'doohickey1000',
|
product: 'doohickey1000',
|
||||||
version: 'alpha',
|
version: 'alpha',
|
||||||
@ -114,9 +120,8 @@ let leef = new SyslogPro.LEEF({
|
|||||||
.then((result) => {})
|
.then((result) => {})
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
console.log(error);
|
console.log(error);
|
||||||
});
|
});</code></pre><p><strong>CEF (Common Event Format)</strong></p>
|
||||||
|
<pre class="prettyprint source lang-js"><code> let cef = new SyslogPro.CEF({
|
||||||
let cef = new SyslogPro.CEF({
|
|
||||||
deviceVendor: 'acme',
|
deviceVendor: 'acme',
|
||||||
deviceProduct: 'doohickey1000',
|
deviceProduct: 'doohickey1000',
|
||||||
deviceVersion: 'alpha',
|
deviceVersion: 'alpha',
|
||||||
@ -134,8 +139,18 @@ let cef = new SyslogPro.CEF({
|
|||||||
.then((result) => {})
|
.then((result) => {})
|
||||||
.catch((error) => {
|
.catch((error) => {
|
||||||
console.log(error);
|
console.log(error);
|
||||||
});</code></pre><h2>Tests</h2><p> <code>npm test</code></p>
|
});</code></pre><h2>API</h2><p>For more details see:</p>
|
||||||
<h2>Contributing</h2><p>Please try to stay close to the Google JS Style Guid, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint and test your code.</p></article>
|
<ul>
|
||||||
|
<li><a href="https://cyamato.github.io/SyslogPro/">JSDoc</a> </li>
|
||||||
|
<li><a href="./docs/api.md">api.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>
|
||||||
|
<ul>
|
||||||
|
<li><a href="https://github.com/cyamato/SyslogPro.git">Repository</a></li>
|
||||||
|
<li><a href="https://github.com/cyamato/SyslogPro/issues">Bug Reporting</a></li>
|
||||||
|
<li><a href="https://github.com/cyamato/SyslogPro/wiki">Wiki</a></li>
|
||||||
|
</ul></article>
|
||||||
</section>
|
</section>
|
||||||
|
|
||||||
|
|
||||||
@ -150,7 +165,7 @@ let cef = new SyslogPro.CEF({
|
|||||||
<br class="clear">
|
<br class="clear">
|
||||||
|
|
||||||
<footer>
|
<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>
|
</footer>
|
||||||
|
|
||||||
<script>prettyPrint();</script>
|
<script>prettyPrint();</script>
|
||||||
|
|||||||
@ -44,11 +44,17 @@
|
|||||||
<pre class="prettyprint source linenums"><code>/** Copyright (c) 2018 Craig Yamato */
|
<pre class="prettyprint source linenums"><code>/** Copyright (c) 2018 Craig Yamato */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @fileoverview The SyslogPro class for sending syslog messages
|
* @fileoverview The SyslogPro module for sending syslog messages
|
||||||
|
* Most APIs will return a promise. These APIs can be used using
|
||||||
|
* `then(...)/catch(...)`
|
||||||
|
*
|
||||||
|
* Syslog formating classes can be used as input into a Syslog class to be used
|
||||||
|
* simultatniusly to the same Syslog server. The Syslog Class with a configured
|
||||||
|
* Syslog server target can also be used as the input into each of the formating
|
||||||
|
* classes so that they may run independtly.
|
||||||
* @author Craig Yamato <craig@kentik.com>
|
* @author Craig Yamato <craig@kentik.com>
|
||||||
* @copyright (c) 2018 - Craig Yamato
|
* @copyright (c) 2018 - Craig Yamato
|
||||||
* @version 0.0.0
|
* @version 0.1.0
|
||||||
* @since 0.0.0
|
|
||||||
* @exports Syslog
|
* @exports Syslog
|
||||||
* @exports LEEF
|
* @exports LEEF
|
||||||
* @exports CEF
|
* @exports CEF
|
||||||
@ -133,15 +139,16 @@ function rgbToAnsi (hex, extendedColor) {
|
|||||||
* A class to work with syslog messages using UDP, TCP, or TLS transport.
|
* A class to work with syslog messages using UDP, TCP, or TLS transport.
|
||||||
* There is suport for Syslog message formating RFC-3164, RFC-5424 including
|
* There is suport for Syslog message formating RFC-3164, RFC-5424 including
|
||||||
* Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
|
* Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
|
||||||
* Event Format). The meesaging is fully configurabule and Ansi foreground
|
* Event Format).
|
||||||
* colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.
|
* Syslog formating classes can be used as input into a Syslog class to be used
|
||||||
|
* simultatniusly to the same Syslog server. *
|
||||||
* @requires moment
|
* @requires moment
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
*/
|
*/
|
||||||
class Syslog {
|
class Syslog {
|
||||||
/**
|
/**
|
||||||
* Construct a new Syslog object with user options
|
* Construct a new Syslog transport object with user options
|
||||||
* @public
|
* @public
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
@ -486,7 +493,18 @@ class Syslog {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A class to work with RFC3164 formated syslog messages.
|
* A class to work with RFC3164 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 RFC3164 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.
|
||||||
* @requires moment
|
* @requires moment
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
@ -1034,7 +1052,18 @@ class RFC3164 {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A class to work with RFC5424 formated syslog messages.
|
* 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.
|
||||||
* @requires moment
|
* @requires moment
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
@ -1705,13 +1734,20 @@ class RFC5424 {
|
|||||||
* be saved to file (Saving to file if not part of this module but a LEEF
|
* be saved to file (Saving to file if not part of this module but a LEEF
|
||||||
* formated mesage produced by this module can be saved externaly to it) or
|
* formated mesage produced by this module can be saved externaly to it) or
|
||||||
* sent via Syslog.
|
* sent via Syslog.
|
||||||
|
* 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
|
||||||
|
* LEEF format is designed to send event data to a SIEM system and should not
|
||||||
|
* be as a logging stream. This class is ment to be used once per message.
|
||||||
* @requires moment
|
* @requires moment
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
*/
|
*/
|
||||||
class LEEF {
|
class LEEF {
|
||||||
/**
|
/**
|
||||||
* Construct a new LEEF object with user options
|
* Construct a new LEEF formating object with user options
|
||||||
* @public
|
* @public
|
||||||
* @param {object} [options] - Options object
|
* @param {object} [options] - Options object
|
||||||
* @param {string} [options.vendor='unknown'] - The vendor of the system that
|
* @param {string} [options.vendor='unknown'] - The vendor of the system that
|
||||||
@ -1862,13 +1898,20 @@ class LEEF {
|
|||||||
* be saved to file (Saving to file if not part of this module but a CEF
|
* be saved to file (Saving to file if not part of this module but a CEF
|
||||||
* formated mesage produced by this module can be saved externaly to it) or
|
* formated mesage produced by this module can be saved externaly to it) or
|
||||||
* sent via Syslog.
|
* sent via Syslog.
|
||||||
|
* 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 CEF
|
||||||
|
* format is designed to send event data to a SIEM system and should not be as
|
||||||
|
* a logging stream. This class is ment to be used once per message.
|
||||||
* @requires moment
|
* @requires moment
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
*/
|
*/
|
||||||
class CEF {
|
class CEF {
|
||||||
/**
|
/**
|
||||||
* Construct a new CEF object with user options
|
* Construct a new CEF formating object with user options
|
||||||
* @public
|
* @public
|
||||||
* @param {object} [options] - Options object
|
* @param {object} [options] - Options object
|
||||||
* @param {string} [options.deviceVendor='unknown'] - The vendor of the system
|
* @param {string} [options.deviceVendor='unknown'] - The vendor of the system
|
||||||
@ -2373,7 +2416,7 @@ module.exports = {
|
|||||||
<br class="clear">
|
<br class="clear">
|
||||||
|
|
||||||
<footer>
|
<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>
|
</footer>
|
||||||
|
|
||||||
<script>prettyPrint();</script>
|
<script>prettyPrint();</script>
|
||||||
|
|||||||
@ -53,7 +53,14 @@
|
|||||||
of system messages are designed to work with security systems. Messages can
|
of system messages are designed to work with security systems. Messages can
|
||||||
be saved to file (Saving to file if not part of this module but a CEF
|
be saved to file (Saving to file if not part of this module but a CEF
|
||||||
formated mesage produced by this module can be saved externaly to it) or
|
formated mesage produced by this module can be saved externaly to it) or
|
||||||
sent via Syslog.</div>
|
sent via Syslog.
|
||||||
|
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 CEF
|
||||||
|
format is designed to send event data to a SIEM system and should not be as
|
||||||
|
a logging stream. This class is ment to be used once per message.</div>
|
||||||
|
|
||||||
|
|
||||||
</header>
|
</header>
|
||||||
@ -80,7 +87,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1826">line 1826</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1869">line 1869</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -126,7 +133,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
|
|
||||||
<div class="description">
|
<div class="description">
|
||||||
Construct a new CEF object with user options
|
Construct a new CEF formating object with user options
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -603,7 +610,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1849">line 1849</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1892">line 1892</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -662,7 +669,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1858">line 1858</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1901">line 1901</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -731,7 +738,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1854">line 1854</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1897">line 1897</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -800,7 +807,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1852">line 1852</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1895">line 1895</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -869,7 +876,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1856">line 1856</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1899">line 1899</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -938,7 +945,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1864">line 1864</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1907">line 1907</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1007,7 +1014,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1860">line 1860</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1903">line 1903</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1076,7 +1083,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2026">line 2026</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2069">line 2069</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1135,7 +1142,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1862">line 1862</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1905">line 1905</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1214,7 +1221,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2266">line 2266</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2309">line 2309</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1320,7 +1327,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2293">line 2293</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2336">line 2336</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1470,7 +1477,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2038">line 2038</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line2081">line 2081</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1608,7 +1615,7 @@ sent via Syslog.</div>
|
|||||||
<br class="clear">
|
<br class="clear">
|
||||||
|
|
||||||
<footer>
|
<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>
|
</footer>
|
||||||
|
|
||||||
<script>prettyPrint();</script>
|
<script>prettyPrint();</script>
|
||||||
|
|||||||
@ -53,7 +53,14 @@
|
|||||||
of system messages are designed to work with security systems. Messages can
|
of system messages are designed to work with security systems. Messages can
|
||||||
be saved to file (Saving to file if not part of this module but a LEEF
|
be saved to file (Saving to file if not part of this module but a LEEF
|
||||||
formated mesage produced by this module can be saved externaly to it) or
|
formated mesage produced by this module can be saved externaly to it) or
|
||||||
sent via Syslog.</div>
|
sent via Syslog.
|
||||||
|
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
|
||||||
|
LEEF format is designed to send event data to a SIEM system and should not
|
||||||
|
be as a logging stream. This class is ment to be used once per message.</div>
|
||||||
|
|
||||||
|
|
||||||
</header>
|
</header>
|
||||||
@ -80,7 +87,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1669">line 1669</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1705">line 1705</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -126,7 +133,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
|
|
||||||
<div class="description">
|
<div class="description">
|
||||||
Construct a new LEEF object with user options
|
Construct a new LEEF formating object with user options
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -564,7 +571,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1707">line 1707</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1743">line 1743</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -633,7 +640,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1693">line 1693</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1729">line 1729</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -692,7 +699,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1702">line 1702</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1738">line 1738</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -761,7 +768,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1698">line 1698</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1734">line 1734</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -830,7 +837,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1758">line 1758</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1794">line 1794</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -889,7 +896,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1704">line 1704</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1740">line 1740</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -958,7 +965,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1696">line 1696</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1732">line 1732</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1027,7 +1034,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1700">line 1700</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1736">line 1736</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1106,7 +1113,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1769">line 1769</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1805">line 1805</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1212,7 +1219,7 @@ sent via Syslog.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1797">line 1797</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1833">line 1833</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1365,7 +1372,7 @@ sent via Syslog.</div>
|
|||||||
<br class="clear">
|
<br class="clear">
|
||||||
|
|
||||||
<footer>
|
<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>
|
</footer>
|
||||||
|
|
||||||
<script>prettyPrint();</script>
|
<script>prettyPrint();</script>
|
||||||
|
|||||||
@ -49,7 +49,18 @@
|
|||||||
RFC3164
|
RFC3164
|
||||||
</h2>
|
</h2>
|
||||||
|
|
||||||
<div class="class-description">A class to work with RFC3164 formated syslog messages.</div>
|
<div class="class-description">A class to work with RFC3164 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 RFC3164 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>
|
</header>
|
||||||
@ -76,7 +87,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line451">line 451</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line469">line 469</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -865,7 +876,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line526">line 526</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line544">line 544</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -924,7 +935,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line504">line 504</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line522">line 522</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -993,7 +1004,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line497">line 497</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line515">line 515</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1052,7 +1063,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line528">line 528</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line546">line 546</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1111,7 +1122,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line538">line 538</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line556">line 556</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1170,7 +1181,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line524">line 524</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line542">line 542</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1229,7 +1240,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line530">line 530</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line548">line 548</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1288,7 +1299,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line510">line 510</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line528">line 528</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1357,7 +1368,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line536">line 536</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line554">line 554</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1416,7 +1427,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line534">line 534</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line552">line 552</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1475,7 +1486,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line517">line 517</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line535">line 535</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1534,7 +1545,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line532">line 532</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line550">line 550</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1603,7 +1614,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line847">line 847</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line865">line 865</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1787,7 +1798,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line733">line 733</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line751">line 751</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2123,7 +2134,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line873">line 873</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line891">line 891</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2307,7 +2318,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line860">line 860</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line878">line 878</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2491,7 +2502,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line985">line 985</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line1003">line 1003</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2675,7 +2686,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line837">line 837</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line855">line 855</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2859,7 +2870,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line824">line 824</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line842">line 842</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3043,7 +3054,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line896">line 896</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line914">line 914</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3227,7 +3238,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line883">line 883</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line901">line 901</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3411,7 +3422,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line965">line 965</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line983">line 983</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3595,7 +3606,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line952">line 952</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line970">line 970</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3779,7 +3790,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line975">line 975</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line993">line 993</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3963,7 +3974,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line942">line 942</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line960">line 960</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -4147,7 +4158,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line929">line 929</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line947">line 947</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -4331,7 +4342,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line797">line 797</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line815">line 815</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -4675,7 +4686,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line582">line 582</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line600">line 600</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -5096,7 +5107,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line919">line 919</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line937">line 937</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -5280,7 +5291,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line906">line 906</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line924">line 924</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -5467,7 +5478,7 @@
|
|||||||
<br class="clear">
|
<br class="clear">
|
||||||
|
|
||||||
<footer>
|
<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>
|
</footer>
|
||||||
|
|
||||||
<script>prettyPrint();</script>
|
<script>prettyPrint();</script>
|
||||||
|
|||||||
@ -49,7 +49,18 @@
|
|||||||
RFC5424
|
RFC5424
|
||||||
</h2>
|
</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>
|
</header>
|
||||||
@ -76,7 +87,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1062,7 +1073,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1121,7 +1132,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1190,7 +1201,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1249,7 +1260,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1308,7 +1319,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1367,7 +1378,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1426,7 +1437,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1495,7 +1506,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1554,7 +1565,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1623,7 +1634,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1682,7 +1693,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1741,7 +1752,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1800,7 +1811,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1869,7 +1880,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1938,7 +1949,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2007,7 +2018,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2076,7 +2087,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2145,7 +2156,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2214,7 +2225,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2398,7 +2409,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2855,7 +2866,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3039,7 +3050,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3223,7 +3234,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3407,7 +3418,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3591,7 +3602,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3775,7 +3786,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -3959,7 +3970,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -4143,7 +4154,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -4327,7 +4338,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -4511,7 +4522,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -4695,7 +4706,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -4879,7 +4890,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -5063,7 +5074,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -5256,7 +5267,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -5677,7 +5688,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -5861,7 +5872,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<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>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -6048,7 +6059,7 @@
|
|||||||
<br class="clear">
|
<br class="clear">
|
||||||
|
|
||||||
<footer>
|
<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>
|
</footer>
|
||||||
|
|
||||||
<script>prettyPrint();</script>
|
<script>prettyPrint();</script>
|
||||||
|
|||||||
@ -52,8 +52,9 @@
|
|||||||
<div class="class-description">A class to work with syslog messages using UDP, TCP, or TLS transport.
|
<div class="class-description">A class to work with syslog messages using UDP, TCP, or TLS transport.
|
||||||
There is suport for Syslog message formating RFC-3164, RFC-5424 including
|
There is suport for Syslog message formating RFC-3164, RFC-5424 including
|
||||||
Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
|
Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
|
||||||
Event Format). The meesaging is fully configurabule and Ansi foreground
|
Event Format).
|
||||||
colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
Syslog formating classes can be used as input into a Syslog class to be used
|
||||||
|
simultatniusly to the same Syslog server. *</div>
|
||||||
|
|
||||||
|
|
||||||
</header>
|
</header>
|
||||||
@ -80,7 +81,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line99">line 99</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line106">line 106</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -126,7 +127,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
|
|
||||||
<div class="description">
|
<div class="description">
|
||||||
Construct a new Syslog object with user options
|
Construct a new Syslog transport object with user options
|
||||||
</div>
|
</div>
|
||||||
|
|
||||||
|
|
||||||
@ -755,7 +756,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line205">line 205</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line212">line 212</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -824,7 +825,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line174">line 174</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line181">line 181</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -893,7 +894,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line197">line 197</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line204">line 204</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -962,7 +963,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line152">line 152</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line159">line 159</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1031,7 +1032,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line149">line 149</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line156">line 156</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1100,7 +1101,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line181">line 181</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line188">line 188</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1169,7 +1170,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line189">line 189</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line196">line 196</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1238,7 +1239,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line147">line 147</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line154">line 154</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1307,7 +1308,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line154">line 154</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line161">line 161</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1376,7 +1377,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line165">line 165</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line172">line 172</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1445,7 +1446,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line169">line 169</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line176">line 176</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1514,7 +1515,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line161">line 161</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line168">line 168</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1583,7 +1584,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line239">line 239</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line246">line 246</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1652,7 +1653,7 @@ colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.</div>
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line235">line 235</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line242">line 242</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -1847,7 +1848,7 @@ input as a file location straing and add it to an array of certificates
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line405">line 405</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line412">line 412</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2059,7 +2060,7 @@ selected transport.
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line287">line 287</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line294">line 294</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2270,7 +2271,7 @@ selected transport.
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line333">line 333</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line340">line 340</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2481,7 +2482,7 @@ selected transport.
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line257">line 257</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line264">line 264</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -2668,7 +2669,7 @@ selected transport.
|
|||||||
<br class="clear">
|
<br class="clear">
|
||||||
|
|
||||||
<footer>
|
<footer>
|
||||||
Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> on Mon Sep 24 2018 06:41:36 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>
|
</footer>
|
||||||
|
|
||||||
<script>prettyPrint();</script>
|
<script>prettyPrint();</script>
|
||||||
|
|||||||
@ -54,7 +54,14 @@
|
|||||||
<div class="container-overview">
|
<div class="container-overview">
|
||||||
|
|
||||||
|
|
||||||
<div class="description">The SyslogPro class for sending syslog messages</div>
|
<div class="description">The SyslogPro module for sending syslog messages
|
||||||
|
Most APIs will return a promise. These APIs can be used using
|
||||||
|
`then(...)/catch(...)`
|
||||||
|
|
||||||
|
Syslog formating classes can be used as input into a Syslog class to be used
|
||||||
|
simultatniusly to the same Syslog server. The Syslog Class with a configured
|
||||||
|
Syslog server target can also be used as the input into each of the formating
|
||||||
|
classes so that they may run independtly.</div>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -74,13 +81,10 @@
|
|||||||
|
|
||||||
|
|
||||||
<dt class="tag-version">Version:</dt>
|
<dt class="tag-version">Version:</dt>
|
||||||
<dd class="tag-version"><ul class="dummy"><li>0.0.0</li></ul></dd>
|
<dd class="tag-version"><ul class="dummy"><li>0.1.0</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
<dt class="tag-since">Since:</dt>
|
|
||||||
<dd class="tag-since"><ul class="dummy"><li>0.0.0</li></ul></dd>
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -203,7 +207,7 @@
|
|||||||
|
|
||||||
<dt class="tag-source">Source:</dt>
|
<dt class="tag-source">Source:</dt>
|
||||||
<dd class="tag-source"><ul class="dummy"><li>
|
<dd class="tag-source"><ul class="dummy"><li>
|
||||||
<a href="index.js.html">index.js</a>, <a href="index.js.html#line29">line 29</a>
|
<a href="index.js.html">index.js</a>, <a href="index.js.html#line35">line 35</a>
|
||||||
</li></ul></dd>
|
</li></ul></dd>
|
||||||
|
|
||||||
|
|
||||||
@ -391,7 +395,7 @@
|
|||||||
<br class="clear">
|
<br class="clear">
|
||||||
|
|
||||||
<footer>
|
<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>
|
</footer>
|
||||||
|
|
||||||
<script>prettyPrint();</script>
|
<script>prettyPrint();</script>
|
||||||
|
|||||||
63
index.js
63
index.js
@ -1,11 +1,17 @@
|
|||||||
/** Copyright (c) 2018 Craig Yamato */
|
/** Copyright (c) 2018 Craig Yamato */
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* @fileoverview The SyslogPro class for sending syslog messages
|
* @fileoverview The SyslogPro module for sending syslog messages
|
||||||
|
* Most APIs will return a promise. These APIs can be used using
|
||||||
|
* `then(...)/catch(...)`
|
||||||
|
*
|
||||||
|
* Syslog formating classes can be used as input into a Syslog class to be used
|
||||||
|
* simultatniusly to the same Syslog server. The Syslog Class with a configured
|
||||||
|
* Syslog server target can also be used as the input into each of the formating
|
||||||
|
* classes so that they may run independtly.
|
||||||
* @author Craig Yamato <craig@kentik.com>
|
* @author Craig Yamato <craig@kentik.com>
|
||||||
* @copyright (c) 2018 - Craig Yamato
|
* @copyright (c) 2018 - Craig Yamato
|
||||||
* @version 0.0.0
|
* @version 0.1.0
|
||||||
* @since 0.0.0
|
|
||||||
* @exports Syslog
|
* @exports Syslog
|
||||||
* @exports LEEF
|
* @exports LEEF
|
||||||
* @exports CEF
|
* @exports CEF
|
||||||
@ -90,15 +96,16 @@ function rgbToAnsi (hex, extendedColor) {
|
|||||||
* A class to work with syslog messages using UDP, TCP, or TLS transport.
|
* A class to work with syslog messages using UDP, TCP, or TLS transport.
|
||||||
* There is suport for Syslog message formating RFC-3164, RFC-5424 including
|
* There is suport for Syslog message formating RFC-3164, RFC-5424 including
|
||||||
* Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
|
* Structured Data, IBM LEEF (Log Event Extended Format), and HP CEF (Common
|
||||||
* Event Format). The meesaging is fully configurabule and Ansi foreground
|
* Event Format).
|
||||||
* colors can be added. Both ANSI 8 and ANSI 256 color are fully suported.
|
* Syslog formating classes can be used as input into a Syslog class to be used
|
||||||
|
* simultatniusly to the same Syslog server. *
|
||||||
* @requires moment
|
* @requires moment
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
*/
|
*/
|
||||||
class Syslog {
|
class Syslog {
|
||||||
/**
|
/**
|
||||||
* Construct a new Syslog object with user options
|
* Construct a new Syslog transport object with user options
|
||||||
* @public
|
* @public
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
@ -443,7 +450,18 @@ class Syslog {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A class to work with RFC3164 formated syslog messages.
|
* A class to work with RFC3164 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 RFC3164 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.
|
||||||
* @requires moment
|
* @requires moment
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
@ -991,7 +1009,18 @@ class RFC3164 {
|
|||||||
}
|
}
|
||||||
|
|
||||||
/**
|
/**
|
||||||
* A class to work with RFC5424 formated syslog messages.
|
* 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.
|
||||||
* @requires moment
|
* @requires moment
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
@ -1662,13 +1691,20 @@ class RFC5424 {
|
|||||||
* be saved to file (Saving to file if not part of this module but a LEEF
|
* be saved to file (Saving to file if not part of this module but a LEEF
|
||||||
* formated mesage produced by this module can be saved externaly to it) or
|
* formated mesage produced by this module can be saved externaly to it) or
|
||||||
* sent via Syslog.
|
* sent via Syslog.
|
||||||
|
* 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
|
||||||
|
* LEEF format is designed to send event data to a SIEM system and should not
|
||||||
|
* be as a logging stream. This class is ment to be used once per message.
|
||||||
* @requires moment
|
* @requires moment
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
*/
|
*/
|
||||||
class LEEF {
|
class LEEF {
|
||||||
/**
|
/**
|
||||||
* Construct a new LEEF object with user options
|
* Construct a new LEEF formating object with user options
|
||||||
* @public
|
* @public
|
||||||
* @param {object} [options] - Options object
|
* @param {object} [options] - Options object
|
||||||
* @param {string} [options.vendor='unknown'] - The vendor of the system that
|
* @param {string} [options.vendor='unknown'] - The vendor of the system that
|
||||||
@ -1819,13 +1855,20 @@ class LEEF {
|
|||||||
* be saved to file (Saving to file if not part of this module but a CEF
|
* be saved to file (Saving to file if not part of this module but a CEF
|
||||||
* formated mesage produced by this module can be saved externaly to it) or
|
* formated mesage produced by this module can be saved externaly to it) or
|
||||||
* sent via Syslog.
|
* sent via Syslog.
|
||||||
|
* 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 CEF
|
||||||
|
* format is designed to send event data to a SIEM system and should not be as
|
||||||
|
* a logging stream. This class is ment to be used once per message.
|
||||||
* @requires moment
|
* @requires moment
|
||||||
* @version 0.0.0
|
* @version 0.0.0
|
||||||
* @since 0.0.0
|
* @since 0.0.0
|
||||||
*/
|
*/
|
||||||
class CEF {
|
class CEF {
|
||||||
/**
|
/**
|
||||||
* Construct a new CEF object with user options
|
* Construct a new CEF formating object with user options
|
||||||
* @public
|
* @public
|
||||||
* @param {object} [options] - Options object
|
* @param {object} [options] - Options object
|
||||||
* @param {string} [options.deviceVendor='unknown'] - The vendor of the system
|
* @param {string} [options.deviceVendor='unknown'] - The vendor of the system
|
||||||
|
|||||||
25
jsdoc.json
Normal file
25
jsdoc.json
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
{
|
||||||
|
"sourceType": "module",
|
||||||
|
"tags": {
|
||||||
|
"allowUnknownTags": true,
|
||||||
|
"dictionaries": ["jsdoc","closure"]
|
||||||
|
},
|
||||||
|
"source": {
|
||||||
|
"includePattern": ".+\\.js(doc|x)?$",
|
||||||
|
"excludePattern": "(^|\\/|\\\\)_"
|
||||||
|
},
|
||||||
|
"plugins": [],
|
||||||
|
"templates": {
|
||||||
|
"cleverLinks": false,
|
||||||
|
"monospaceLinks": false,
|
||||||
|
"default": {
|
||||||
|
"outputSourceFiles": true
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"opts": {
|
||||||
|
"destination": "./docs",
|
||||||
|
"private": true,
|
||||||
|
"readme": "./README.md",
|
||||||
|
"template": "./node_modules/docdash"
|
||||||
|
}
|
||||||
|
}
|
||||||
22
jsdoc2md/api.hbs
Normal file
22
jsdoc2md/api.hbs
Normal file
@ -0,0 +1,22 @@
|
|||||||
|
API
|
||||||
|
==========================
|
||||||
|
|
||||||
|
- back to [README.md](../README.md)
|
||||||
|
|
||||||
|
API convention
|
||||||
|
==
|
||||||
|
|
||||||
|
{{>main}}
|
||||||
|
|
||||||
|
*docs autogenerated via [jsdoc2md]
|
||||||
|
(https://github.com/jsdoc2md/jsdoc-to-markdown)*
|
||||||
|
|
||||||
|
## Test
|
||||||
|
```shell
|
||||||
|
npm test
|
||||||
|
```
|
||||||
|
|
||||||
|
## Contributing
|
||||||
|
|
||||||
|
Please try to maintain the existing coding style. Add unit tests for any new or
|
||||||
|
changed functionality. Lint and test your code.
|
||||||
444
package-lock.json
generated
444
package-lock.json
generated
@ -80,6 +80,15 @@
|
|||||||
"json-schema-traverse": "^0.3.0"
|
"json-schema-traverse": "^0.3.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"ansi-escape-sequences": {
|
||||||
|
"version": "4.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/ansi-escape-sequences/-/ansi-escape-sequences-4.0.0.tgz",
|
||||||
|
"integrity": "sha512-v+0wW9Wezwsyb0uF4aBVCjmSqit3Ru7PZFziGF0o2KwTvN2zWfTi3BRLq9EkJFdg3eBbyERXGTntVpBxH1J68Q==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"ansi-escapes": {
|
"ansi-escapes": {
|
||||||
"version": "3.1.0",
|
"version": "3.1.0",
|
||||||
"resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-3.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/ansi-escapes/-/ansi-escapes-3.1.0.tgz",
|
||||||
@ -405,6 +414,16 @@
|
|||||||
"sprintf-js": "~1.0.2"
|
"sprintf-js": "~1.0.2"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"argv-tools": {
|
||||||
|
"version": "0.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/argv-tools/-/argv-tools-0.1.1.tgz",
|
||||||
|
"integrity": "sha512-Cc0dBvx4dvrjjKpyDA6w8RlNAw8Su30NvZbWl/Tv9ZALEVlLVkWQiHMi84Q0xNfpVuSaiQbYkdmWK8g1PLGhKw==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"find-replace": "^2.0.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
"arr-diff": {
|
"arr-diff": {
|
||||||
"version": "2.0.0",
|
"version": "2.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/arr-diff/-/arr-diff-2.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/arr-diff/-/arr-diff-2.0.0.tgz",
|
||||||
@ -426,6 +445,15 @@
|
|||||||
"integrity": "sha1-45sJrqne+Gao8gbiiK9jkZuuOcQ=",
|
"integrity": "sha1-45sJrqne+Gao8gbiiK9jkZuuOcQ=",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"array-back": {
|
||||||
|
"version": "2.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/array-back/-/array-back-2.0.0.tgz",
|
||||||
|
"integrity": "sha512-eJv4pLLufP3g5kcZry0j6WXpIbzYw9GUB4mVJZno9wfwiBxbizTnHCw3VJb07cBihbFX48Y7oSrW9y+gt4glyw==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"typical": "^2.6.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
"array-equal": {
|
"array-equal": {
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/array-equal/-/array-equal-1.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/array-equal/-/array-equal-1.0.0.tgz",
|
||||||
@ -907,6 +935,17 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"cache-point": {
|
||||||
|
"version": "0.4.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/cache-point/-/cache-point-0.4.1.tgz",
|
||||||
|
"integrity": "sha512-4TgWfe9SF+bUy5cCql8gWHqKNrviufNwSYxLjf2utB0pY4+bdcuFwMmY1hDB+67Gz/L1vmhFNhePAjJTFBtV+Q==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"fs-then-native": "^2.0.0",
|
||||||
|
"mkdirp2": "^1.0.3"
|
||||||
|
}
|
||||||
|
},
|
||||||
"callsites": {
|
"callsites": {
|
||||||
"version": "2.0.0",
|
"version": "2.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/callsites/-/callsites-2.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/callsites/-/callsites-2.0.0.tgz",
|
||||||
@ -1012,6 +1051,16 @@
|
|||||||
"integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=",
|
"integrity": "sha1-DQcLTQQ6W+ozovGkDi7bPZpMz3c=",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"collect-all": {
|
||||||
|
"version": "1.0.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/collect-all/-/collect-all-1.0.3.tgz",
|
||||||
|
"integrity": "sha512-0y0rBgoX8IzIjBAUnO73SEtSb4Mhk3IoceWJq5zZSxb9mWORhWH8xLYo4EDSOE1jRBk1LhmfjqWFFt10h/+MEA==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"stream-connect": "^1.0.2",
|
||||||
|
"stream-via": "^1.0.4"
|
||||||
|
}
|
||||||
|
},
|
||||||
"collection-visit": {
|
"collection-visit": {
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/collection-visit/-/collection-visit-1.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/collection-visit/-/collection-visit-1.0.0.tgz",
|
||||||
@ -1046,12 +1095,56 @@
|
|||||||
"delayed-stream": "~1.0.0"
|
"delayed-stream": "~1.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"command-line-args": {
|
||||||
|
"version": "5.0.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/command-line-args/-/command-line-args-5.0.2.tgz",
|
||||||
|
"integrity": "sha512-/qPcbL8zpqg53x4rAaqMFlRV4opN3pbla7I7k9x8kyOBMQoGT6WltjN6sXZuxOXw6DgdK7Ad+ijYS5gjcr7vlA==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"argv-tools": "^0.1.1",
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"find-replace": "^2.0.1",
|
||||||
|
"lodash.camelcase": "^4.3.0",
|
||||||
|
"typical": "^2.6.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"command-line-tool": {
|
||||||
|
"version": "0.8.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/command-line-tool/-/command-line-tool-0.8.0.tgz",
|
||||||
|
"integrity": "sha512-Xw18HVx/QzQV3Sc5k1vy3kgtOeGmsKIqwtFFoyjI4bbcpSgnw2CWVULvtakyw4s6fhyAdI6soQQhXc2OzJy62g==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"ansi-escape-sequences": "^4.0.0",
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"command-line-args": "^5.0.0",
|
||||||
|
"command-line-usage": "^4.1.0",
|
||||||
|
"typical": "^2.6.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"command-line-usage": {
|
||||||
|
"version": "4.1.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/command-line-usage/-/command-line-usage-4.1.0.tgz",
|
||||||
|
"integrity": "sha512-MxS8Ad995KpdAC0Jopo/ovGIroV/m0KHwzKfXxKag6FHOkGsH8/lv5yjgablcRxCJJC0oJeUMuO/gmaq+Wq46g==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"ansi-escape-sequences": "^4.0.0",
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"table-layout": "^0.4.2",
|
||||||
|
"typical": "^2.6.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
"commander": {
|
"commander": {
|
||||||
"version": "2.18.0",
|
"version": "2.18.0",
|
||||||
"resolved": "https://registry.npmjs.org/commander/-/commander-2.18.0.tgz",
|
"resolved": "https://registry.npmjs.org/commander/-/commander-2.18.0.tgz",
|
||||||
"integrity": "sha512-6CYPa+JP2ftfRU2qkDK+UTVeQYosOg/2GbcjIcKPHfinyOLPVGXu/ovN86RP49Re5ndJK1N0kuiidFFuepc4ZQ==",
|
"integrity": "sha512-6CYPa+JP2ftfRU2qkDK+UTVeQYosOg/2GbcjIcKPHfinyOLPVGXu/ovN86RP49Re5ndJK1N0kuiidFFuepc4ZQ==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"common-sequence": {
|
||||||
|
"version": "1.0.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/common-sequence/-/common-sequence-1.0.2.tgz",
|
||||||
|
"integrity": "sha1-MOB/P49vf5s97oVPILLTnu4Ibeg=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"component-emitter": {
|
"component-emitter": {
|
||||||
"version": "1.2.1",
|
"version": "1.2.1",
|
||||||
"resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.2.1.tgz",
|
"resolved": "https://registry.npmjs.org/component-emitter/-/component-emitter-1.2.1.tgz",
|
||||||
@ -1064,6 +1157,23 @@
|
|||||||
"integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=",
|
"integrity": "sha1-2Klr13/Wjfd5OnMDajug1UBdR3s=",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"config-master": {
|
||||||
|
"version": "3.1.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/config-master/-/config-master-3.1.0.tgz",
|
||||||
|
"integrity": "sha1-ZnZjWQUFooO/JqSE1oSJ10xUhdo=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"walk-back": "^2.0.1"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"walk-back": {
|
||||||
|
"version": "2.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/walk-back/-/walk-back-2.0.1.tgz",
|
||||||
|
"integrity": "sha1-VU4qnYdPrEeoywBr9EwvDEmYoKQ=",
|
||||||
|
"dev": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"convert-source-map": {
|
"convert-source-map": {
|
||||||
"version": "1.6.0",
|
"version": "1.6.0",
|
||||||
"resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-1.6.0.tgz",
|
"resolved": "https://registry.npmjs.org/convert-source-map/-/convert-source-map-1.6.0.tgz",
|
||||||
@ -1193,6 +1303,12 @@
|
|||||||
"integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=",
|
"integrity": "sha1-6zkTMzRYd1y4TNGh+uBiEGu4dUU=",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"deep-extend": {
|
||||||
|
"version": "0.6.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/deep-extend/-/deep-extend-0.6.0.tgz",
|
||||||
|
"integrity": "sha512-LOHxIOaPYdHlJRtCQfDIVZtfw/ufM8+rVj649RIHzcm/vGwQRXFt6OPqIFWsm2XEMrNIEtWR64sY1LEKD2vAOA==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"deep-is": {
|
"deep-is": {
|
||||||
"version": "0.1.3",
|
"version": "0.1.3",
|
||||||
"resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.3.tgz",
|
"resolved": "https://registry.npmjs.org/deep-is/-/deep-is-0.1.3.tgz",
|
||||||
@ -1297,6 +1413,34 @@
|
|||||||
"integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==",
|
"integrity": "sha512-A46qtFgd+g7pDZinpnwiRJtxbC1hpgf0uzP3iG89scHk0AUC7A1TGxf5OiiOUv/JMZR8GOt8hL900hV0bOy5xA==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"dmd": {
|
||||||
|
"version": "3.0.12",
|
||||||
|
"resolved": "https://registry.npmjs.org/dmd/-/dmd-3.0.12.tgz",
|
||||||
|
"integrity": "sha512-79w644JdsB2TthYpVl2bDurX7i9Abaegg2E7X46Ajc135aASTMXxrHzJ9mOa5X5nbmnXwlBYiF68K+1baX+BzQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"cache-point": "^0.4.1",
|
||||||
|
"common-sequence": "^1.0.2",
|
||||||
|
"file-set": "^2.0.0",
|
||||||
|
"handlebars": "^4.0.11",
|
||||||
|
"marked": "^0.3.16",
|
||||||
|
"object-get": "^2.1.0",
|
||||||
|
"reduce-flatten": "^1.0.1",
|
||||||
|
"reduce-unique": "^1.0.0",
|
||||||
|
"reduce-without": "^1.0.1",
|
||||||
|
"test-value": "^3.0.0",
|
||||||
|
"walk-back": "^3.0.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"marked": {
|
||||||
|
"version": "0.3.19",
|
||||||
|
"resolved": "https://registry.npmjs.org/marked/-/marked-0.3.19.tgz",
|
||||||
|
"integrity": "sha512-ea2eGWOqNxPcXv8dyERdSr/6FmzvWwzjMxpfGB/sbMccXoct+xY+YukPD+QTUZwyvK7BZwcr4m21WBOW41pAkg==",
|
||||||
|
"dev": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"docco": {
|
"docco": {
|
||||||
"version": "0.8.0",
|
"version": "0.8.0",
|
||||||
"resolved": "https://registry.npmjs.org/docco/-/docco-0.8.0.tgz",
|
"resolved": "https://registry.npmjs.org/docco/-/docco-0.8.0.tgz",
|
||||||
@ -1552,6 +1696,16 @@
|
|||||||
"bser": "^2.0.0"
|
"bser": "^2.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"file-set": {
|
||||||
|
"version": "2.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/file-set/-/file-set-2.0.1.tgz",
|
||||||
|
"integrity": "sha512-XgOUUpgR6FbbfYcniLw0qm1Am7PnNYIAkd+eXxRt42LiYhjaso0WiuQ+VmrNdtwotyM+cLCfZ56AZrySP3QnKA==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"glob": "^7.1.3"
|
||||||
|
}
|
||||||
|
},
|
||||||
"filename-regex": {
|
"filename-regex": {
|
||||||
"version": "2.0.1",
|
"version": "2.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/filename-regex/-/filename-regex-2.0.1.tgz",
|
"resolved": "https://registry.npmjs.org/filename-regex/-/filename-regex-2.0.1.tgz",
|
||||||
@ -1581,6 +1735,16 @@
|
|||||||
"repeat-string": "^1.5.2"
|
"repeat-string": "^1.5.2"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"find-replace": {
|
||||||
|
"version": "2.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/find-replace/-/find-replace-2.0.1.tgz",
|
||||||
|
"integrity": "sha512-LzDo3Fpa30FLIBsh6DCDnMN1KW2g4QKkqKmejlImgWY67dDFPX/x9Kh/op/GK522DchQXEvDi/wD48HKW49XOQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"test-value": "^3.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"find-up": {
|
"find-up": {
|
||||||
"version": "2.1.0",
|
"version": "2.1.0",
|
||||||
"resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/find-up/-/find-up-2.1.0.tgz",
|
||||||
@ -1653,6 +1817,12 @@
|
|||||||
"universalify": "^0.1.0"
|
"universalify": "^0.1.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"fs-then-native": {
|
||||||
|
"version": "2.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/fs-then-native/-/fs-then-native-2.0.0.tgz",
|
||||||
|
"integrity": "sha1-GaEk2U2QwiyOBF8ujdbr6jbUjGc=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"fs.realpath": {
|
"fs.realpath": {
|
||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
|
||||||
@ -1720,7 +1890,8 @@
|
|||||||
"code-point-at": {
|
"code-point-at": {
|
||||||
"version": "1.1.0",
|
"version": "1.1.0",
|
||||||
"bundled": true,
|
"bundled": true,
|
||||||
"dev": true
|
"dev": true,
|
||||||
|
"optional": true
|
||||||
},
|
},
|
||||||
"concat-map": {
|
"concat-map": {
|
||||||
"version": "0.0.1",
|
"version": "0.0.1",
|
||||||
@ -1730,7 +1901,8 @@
|
|||||||
"console-control-strings": {
|
"console-control-strings": {
|
||||||
"version": "1.1.0",
|
"version": "1.1.0",
|
||||||
"bundled": true,
|
"bundled": true,
|
||||||
"dev": true
|
"dev": true,
|
||||||
|
"optional": true
|
||||||
},
|
},
|
||||||
"core-util-is": {
|
"core-util-is": {
|
||||||
"version": "1.0.2",
|
"version": "1.0.2",
|
||||||
@ -1847,7 +2019,8 @@
|
|||||||
"inherits": {
|
"inherits": {
|
||||||
"version": "2.0.3",
|
"version": "2.0.3",
|
||||||
"bundled": true,
|
"bundled": true,
|
||||||
"dev": true
|
"dev": true,
|
||||||
|
"optional": true
|
||||||
},
|
},
|
||||||
"ini": {
|
"ini": {
|
||||||
"version": "1.3.5",
|
"version": "1.3.5",
|
||||||
@ -1859,6 +2032,7 @@
|
|||||||
"version": "1.0.0",
|
"version": "1.0.0",
|
||||||
"bundled": true,
|
"bundled": true,
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"optional": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"number-is-nan": "^1.0.0"
|
"number-is-nan": "^1.0.0"
|
||||||
}
|
}
|
||||||
@ -1984,7 +2158,8 @@
|
|||||||
"number-is-nan": {
|
"number-is-nan": {
|
||||||
"version": "1.0.1",
|
"version": "1.0.1",
|
||||||
"bundled": true,
|
"bundled": true,
|
||||||
"dev": true
|
"dev": true,
|
||||||
|
"optional": true
|
||||||
},
|
},
|
||||||
"object-assign": {
|
"object-assign": {
|
||||||
"version": "4.1.1",
|
"version": "4.1.1",
|
||||||
@ -1996,6 +2171,7 @@
|
|||||||
"version": "1.4.0",
|
"version": "1.4.0",
|
||||||
"bundled": true,
|
"bundled": true,
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"optional": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"wrappy": "1"
|
"wrappy": "1"
|
||||||
}
|
}
|
||||||
@ -2117,6 +2293,7 @@
|
|||||||
"version": "1.0.2",
|
"version": "1.0.2",
|
||||||
"bundled": true,
|
"bundled": true,
|
||||||
"dev": true,
|
"dev": true,
|
||||||
|
"optional": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"code-point-at": "^1.0.0",
|
"code-point-at": "^1.0.0",
|
||||||
"is-fullwidth-code-point": "^1.0.0",
|
"is-fullwidth-code-point": "^1.0.0",
|
||||||
@ -3337,6 +3514,52 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"jsdoc-api": {
|
||||||
|
"version": "4.0.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/jsdoc-api/-/jsdoc-api-4.0.3.tgz",
|
||||||
|
"integrity": "sha512-dfYq9JgB+XahY0XfSEw93PmXmocjwYcvJ5aMuQUJ/OdDRGWamf2SSOk3W06Bsj8qdjp/UdefzqpP/mpwsvHuvA==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"cache-point": "^0.4.1",
|
||||||
|
"collect-all": "^1.0.3",
|
||||||
|
"file-set": "^2.0.0",
|
||||||
|
"fs-then-native": "^2.0.0",
|
||||||
|
"jsdoc": "~3.5.5",
|
||||||
|
"object-to-spawn-args": "^1.1.1",
|
||||||
|
"temp-path": "^1.0.0",
|
||||||
|
"walk-back": "^3.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"jsdoc-parse": {
|
||||||
|
"version": "3.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/jsdoc-parse/-/jsdoc-parse-3.0.1.tgz",
|
||||||
|
"integrity": "sha512-btZLp4wYl90vcAfgk4hoGQbO17iBVrhh3LJRMKZNtZgniO3F8H2CjxXld0owBIB1XxN+j3bAcWZnZKMnSj3iMA==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"lodash.omit": "^4.5.0",
|
||||||
|
"lodash.pick": "^4.4.0",
|
||||||
|
"reduce-extract": "^1.0.0",
|
||||||
|
"sort-array": "^2.0.0",
|
||||||
|
"test-value": "^3.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"jsdoc-to-markdown": {
|
||||||
|
"version": "4.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/jsdoc-to-markdown/-/jsdoc-to-markdown-4.0.1.tgz",
|
||||||
|
"integrity": "sha512-LHJRoLoLyDdxNcColgkLoB/rFG5iRP+PNJjMILI0x+95IdEAtyjSt0wJ6ZlKxRpkhBYtQXTQQ119hMqPIUZzTQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"command-line-tool": "^0.8.0",
|
||||||
|
"config-master": "^3.1.0",
|
||||||
|
"dmd": "^3.0.10",
|
||||||
|
"jsdoc-api": "^4.0.1",
|
||||||
|
"jsdoc-parse": "^3.0.1",
|
||||||
|
"walk-back": "^3.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"jsdom": {
|
"jsdom": {
|
||||||
"version": "11.12.0",
|
"version": "11.12.0",
|
||||||
"resolved": "https://registry.npmjs.org/jsdom/-/jsdom-11.12.0.tgz",
|
"resolved": "https://registry.npmjs.org/jsdom/-/jsdom-11.12.0.tgz",
|
||||||
@ -3512,6 +3735,30 @@
|
|||||||
"integrity": "sha512-cQKh8igo5QUhZ7lg38DYWAxMvjSAKG0A8wGSVimP07SIUEK2UO+arSRKbRZWtelMtN5V0Hkwh5ryOto/SshYIg==",
|
"integrity": "sha512-cQKh8igo5QUhZ7lg38DYWAxMvjSAKG0A8wGSVimP07SIUEK2UO+arSRKbRZWtelMtN5V0Hkwh5ryOto/SshYIg==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"lodash.camelcase": {
|
||||||
|
"version": "4.3.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/lodash.camelcase/-/lodash.camelcase-4.3.0.tgz",
|
||||||
|
"integrity": "sha1-soqmKIorn8ZRA1x3EfZathkDMaY=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"lodash.omit": {
|
||||||
|
"version": "4.5.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/lodash.omit/-/lodash.omit-4.5.0.tgz",
|
||||||
|
"integrity": "sha1-brGa5aHuHdnfC5aeZs4Lf6MLXmA=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"lodash.padend": {
|
||||||
|
"version": "4.6.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/lodash.padend/-/lodash.padend-4.6.1.tgz",
|
||||||
|
"integrity": "sha1-U8y6BH0G4VjTEfRdpiX05J5vFm4=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"lodash.pick": {
|
||||||
|
"version": "4.4.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/lodash.pick/-/lodash.pick-4.4.0.tgz",
|
||||||
|
"integrity": "sha1-UvBWEP/53tQiYRRB7R/BI6AwAbM=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"lodash.sortby": {
|
"lodash.sortby": {
|
||||||
"version": "4.7.0",
|
"version": "4.7.0",
|
||||||
"resolved": "https://registry.npmjs.org/lodash.sortby/-/lodash.sortby-4.7.0.tgz",
|
"resolved": "https://registry.npmjs.org/lodash.sortby/-/lodash.sortby-4.7.0.tgz",
|
||||||
@ -3690,6 +3937,12 @@
|
|||||||
"minimist": "0.0.8"
|
"minimist": "0.0.8"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"mkdirp2": {
|
||||||
|
"version": "1.0.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/mkdirp2/-/mkdirp2-1.0.4.tgz",
|
||||||
|
"integrity": "sha512-Q2PKB4ZR4UPtjLl76JfzlgSCUZhSV1AXQgAZa1qt5RiaALFjP/CDrGvFBrOz7Ck6McPcwMAxTsJvWOUjOU8XMw==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"moment": {
|
"moment": {
|
||||||
"version": "2.22.2",
|
"version": "2.22.2",
|
||||||
"resolved": "https://registry.npmjs.org/moment/-/moment-2.22.2.tgz",
|
"resolved": "https://registry.npmjs.org/moment/-/moment-2.22.2.tgz",
|
||||||
@ -3847,12 +4100,24 @@
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"object-get": {
|
||||||
|
"version": "2.1.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/object-get/-/object-get-2.1.0.tgz",
|
||||||
|
"integrity": "sha1-ciu9tgA576R8rTxtws5RqFwCxa4=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"object-keys": {
|
"object-keys": {
|
||||||
"version": "1.0.12",
|
"version": "1.0.12",
|
||||||
"resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.0.12.tgz",
|
"resolved": "https://registry.npmjs.org/object-keys/-/object-keys-1.0.12.tgz",
|
||||||
"integrity": "sha512-FTMyFUm2wBcGHnH2eXmz7tC6IwlqQZ6mVZ+6dm6vZ4IQIHjs6FdNsQBuKGPuUUUY6NfJw2PshC08Tn6LzLDOag==",
|
"integrity": "sha512-FTMyFUm2wBcGHnH2eXmz7tC6IwlqQZ6mVZ+6dm6vZ4IQIHjs6FdNsQBuKGPuUUUY6NfJw2PshC08Tn6LzLDOag==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"object-to-spawn-args": {
|
||||||
|
"version": "1.1.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/object-to-spawn-args/-/object-to-spawn-args-1.1.1.tgz",
|
||||||
|
"integrity": "sha1-d9qIJ/Bz0BHJ4bFz+JV4FHAkZ4U=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"object-visit": {
|
"object-visit": {
|
||||||
"version": "1.0.1",
|
"version": "1.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/object-visit/-/object-visit-1.0.1.tgz",
|
"resolved": "https://registry.npmjs.org/object-visit/-/object-visit-1.0.1.tgz",
|
||||||
@ -4284,6 +4549,78 @@
|
|||||||
"util.promisify": "^1.0.0"
|
"util.promisify": "^1.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"reduce-extract": {
|
||||||
|
"version": "1.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/reduce-extract/-/reduce-extract-1.0.0.tgz",
|
||||||
|
"integrity": "sha1-Z/I4W+2mUGG19fQxJmLosIDKFSU=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"test-value": "^1.0.1"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"array-back": {
|
||||||
|
"version": "1.0.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz",
|
||||||
|
"integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"typical": "^2.6.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"test-value": {
|
||||||
|
"version": "1.1.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/test-value/-/test-value-1.1.0.tgz",
|
||||||
|
"integrity": "sha1-oJE29y7AQ9J8iTcHwrFZv6196T8=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^1.0.2",
|
||||||
|
"typical": "^2.4.2"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"reduce-flatten": {
|
||||||
|
"version": "1.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/reduce-flatten/-/reduce-flatten-1.0.1.tgz",
|
||||||
|
"integrity": "sha1-JYx479FT3fk8tWEjf2EYTzaW4yc=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"reduce-unique": {
|
||||||
|
"version": "1.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/reduce-unique/-/reduce-unique-1.0.0.tgz",
|
||||||
|
"integrity": "sha1-flhrz4ek4ytter2Cd/rWzeyfSAM=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"reduce-without": {
|
||||||
|
"version": "1.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/reduce-without/-/reduce-without-1.0.1.tgz",
|
||||||
|
"integrity": "sha1-aK0OrRGFXJo31OglbBW7+Hly/Iw=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"test-value": "^2.0.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"array-back": {
|
||||||
|
"version": "1.0.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz",
|
||||||
|
"integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"typical": "^2.6.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"test-value": {
|
||||||
|
"version": "2.1.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/test-value/-/test-value-2.1.0.tgz",
|
||||||
|
"integrity": "sha1-Edpv9nDzRxpztiXKTz/c97t0gpE=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^1.0.3",
|
||||||
|
"typical": "^2.6.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"regenerator-runtime": {
|
"regenerator-runtime": {
|
||||||
"version": "0.11.1",
|
"version": "0.11.1",
|
||||||
"resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.11.1.tgz",
|
"resolved": "https://registry.npmjs.org/regenerator-runtime/-/regenerator-runtime-0.11.1.tgz",
|
||||||
@ -4969,6 +5306,28 @@
|
|||||||
"kind-of": "^3.2.0"
|
"kind-of": "^3.2.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"sort-array": {
|
||||||
|
"version": "2.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/sort-array/-/sort-array-2.0.0.tgz",
|
||||||
|
"integrity": "sha1-OKnG2if9fRR7QuYFVPKBGHtN9HI=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^1.0.4",
|
||||||
|
"object-get": "^2.1.0",
|
||||||
|
"typical": "^2.6.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"array-back": {
|
||||||
|
"version": "1.0.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz",
|
||||||
|
"integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"typical": "^2.6.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"source-map": {
|
"source-map": {
|
||||||
"version": "0.5.7",
|
"version": "0.5.7",
|
||||||
"resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz",
|
"resolved": "https://registry.npmjs.org/source-map/-/source-map-0.5.7.tgz",
|
||||||
@ -5100,6 +5459,32 @@
|
|||||||
"integrity": "sha1-NbCYdbT/SfJqd35QmzCQoyJr8ks=",
|
"integrity": "sha1-NbCYdbT/SfJqd35QmzCQoyJr8ks=",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"stream-connect": {
|
||||||
|
"version": "1.0.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/stream-connect/-/stream-connect-1.0.2.tgz",
|
||||||
|
"integrity": "sha1-GLyB8u2zW4tdmoAJIAqYUxRCipc=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^1.0.2"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"array-back": {
|
||||||
|
"version": "1.0.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/array-back/-/array-back-1.0.4.tgz",
|
||||||
|
"integrity": "sha1-ZEun8JX3/898Q7Xw3DnTwfA8Bjs=",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"typical": "^2.6.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
|
"stream-via": {
|
||||||
|
"version": "1.0.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/stream-via/-/stream-via-1.0.4.tgz",
|
||||||
|
"integrity": "sha512-DBp0lSvX5G9KGRDTkR/R+a29H+Wk2xItOF+MpZLLNDWbEV9tGPnqLPxHEYjmiz8xGtJHRIqmI+hCjmNzqoA4nQ==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"string-length": {
|
"string-length": {
|
||||||
"version": "2.0.0",
|
"version": "2.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/string-length/-/string-length-2.0.0.tgz",
|
"resolved": "https://registry.npmjs.org/string-length/-/string-length-2.0.0.tgz",
|
||||||
@ -5182,12 +5567,31 @@
|
|||||||
"integrity": "sha1-rifbOPZgp64uHDt9G8KQgZuFGeY=",
|
"integrity": "sha1-rifbOPZgp64uHDt9G8KQgZuFGeY=",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"table-layout": {
|
||||||
|
"version": "0.4.4",
|
||||||
|
"resolved": "https://registry.npmjs.org/table-layout/-/table-layout-0.4.4.tgz",
|
||||||
|
"integrity": "sha512-uNaR3SRMJwfdp9OUr36eyEi6LLsbcTqTO/hfTsNviKsNeyMBPICJCC7QXRF3+07bAP6FRwA8rczJPBqXDc0CkQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"deep-extend": "~0.6.0",
|
||||||
|
"lodash.padend": "^4.6.1",
|
||||||
|
"typical": "^2.6.1",
|
||||||
|
"wordwrapjs": "^3.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"taffydb": {
|
"taffydb": {
|
||||||
"version": "2.6.2",
|
"version": "2.6.2",
|
||||||
"resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz",
|
"resolved": "https://registry.npmjs.org/taffydb/-/taffydb-2.6.2.tgz",
|
||||||
"integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg=",
|
"integrity": "sha1-fLy2S1oUG2ou/CxdLGe04VCyomg=",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"temp-path": {
|
||||||
|
"version": "1.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/temp-path/-/temp-path-1.0.0.tgz",
|
||||||
|
"integrity": "sha1-JLFUOXOrRCiW2a02fdnL2/r+kYs=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"test-exclude": {
|
"test-exclude": {
|
||||||
"version": "4.2.3",
|
"version": "4.2.3",
|
||||||
"resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-4.2.3.tgz",
|
"resolved": "https://registry.npmjs.org/test-exclude/-/test-exclude-4.2.3.tgz",
|
||||||
@ -5201,6 +5605,16 @@
|
|||||||
"require-main-filename": "^1.0.1"
|
"require-main-filename": "^1.0.1"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"test-value": {
|
||||||
|
"version": "3.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/test-value/-/test-value-3.0.0.tgz",
|
||||||
|
"integrity": "sha512-sVACdAWcZkSU9x7AOmJo5TqE+GyNJknHaHsMrR6ZnhjVlVN9Yx6FjHrsKZ3BjIpPCT68zYesPWkakrNupwfOTQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"array-back": "^2.0.0",
|
||||||
|
"typical": "^2.6.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
"throat": {
|
"throat": {
|
||||||
"version": "4.1.0",
|
"version": "4.1.0",
|
||||||
"resolved": "https://registry.npmjs.org/throat/-/throat-4.1.0.tgz",
|
"resolved": "https://registry.npmjs.org/throat/-/throat-4.1.0.tgz",
|
||||||
@ -5319,6 +5733,12 @@
|
|||||||
"prelude-ls": "~1.1.2"
|
"prelude-ls": "~1.1.2"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"typical": {
|
||||||
|
"version": "2.6.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/typical/-/typical-2.6.1.tgz",
|
||||||
|
"integrity": "sha1-XAgOXWYcu+OCWdLnCjxyU+hziB0=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"uglify-js": {
|
"uglify-js": {
|
||||||
"version": "3.4.9",
|
"version": "3.4.9",
|
||||||
"resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.4.9.tgz",
|
"resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.4.9.tgz",
|
||||||
@ -5520,6 +5940,12 @@
|
|||||||
"browser-process-hrtime": "^0.1.2"
|
"browser-process-hrtime": "^0.1.2"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"walk-back": {
|
||||||
|
"version": "3.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/walk-back/-/walk-back-3.0.0.tgz",
|
||||||
|
"integrity": "sha1-I1h4ejXakQMtrV6S+AsSNw2HlcU=",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"walker": {
|
"walker": {
|
||||||
"version": "1.0.7",
|
"version": "1.0.7",
|
||||||
"resolved": "https://registry.npmjs.org/walker/-/walker-1.0.7.tgz",
|
"resolved": "https://registry.npmjs.org/walker/-/walker-1.0.7.tgz",
|
||||||
@ -5600,6 +6026,16 @@
|
|||||||
"integrity": "sha1-o9XabNXAvAAI03I0u68b7WMFkQc=",
|
"integrity": "sha1-o9XabNXAvAAI03I0u68b7WMFkQc=",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"wordwrapjs": {
|
||||||
|
"version": "3.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/wordwrapjs/-/wordwrapjs-3.0.0.tgz",
|
||||||
|
"integrity": "sha512-mO8XtqyPvykVCsrwj5MlOVWvSnCdT+C+QVbm6blradR7JExAhbkZ7hZ9A+9NUtwzSqrlUo9a67ws0EiILrvRpw==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"reduce-flatten": "^1.0.1",
|
||||||
|
"typical": "^2.6.1"
|
||||||
|
}
|
||||||
|
},
|
||||||
"wrap-ansi": {
|
"wrap-ansi": {
|
||||||
"version": "2.1.0",
|
"version": "2.1.0",
|
||||||
"resolved": "http://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz",
|
"resolved": "http://registry.npmjs.org/wrap-ansi/-/wrap-ansi-2.1.0.tgz",
|
||||||
|
|||||||
10
package.json
10
package.json
@ -48,7 +48,7 @@
|
|||||||
"doc": "./docs",
|
"doc": "./docs",
|
||||||
"example": "./example",
|
"example": "./example",
|
||||||
"test": "./test"
|
"test": "./test"
|
||||||
}
|
},
|
||||||
"main": "index.js",
|
"main": "index.js",
|
||||||
"engines": {
|
"engines": {
|
||||||
"node": ">=10.0.0"
|
"node": ">=10.0.0"
|
||||||
@ -61,11 +61,15 @@
|
|||||||
"docco": "^0.8.0",
|
"docco": "^0.8.0",
|
||||||
"docdash": "^1.0.0",
|
"docdash": "^1.0.0",
|
||||||
"jest": "^23.5.0",
|
"jest": "^23.5.0",
|
||||||
"jsdoc": "^3.5.5"
|
"jsdoc": "^3.5.5",
|
||||||
|
"jsdoc-to-markdown": "^4.0.1"
|
||||||
},
|
},
|
||||||
"scripts": {
|
"scripts": {
|
||||||
"test": "jest --colors --expand --logHeapUsage --runInBand && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
|
"test": "jest --colors --expand --logHeapUsage --runInBand && cat ./coverage/lcov.info | ./node_modules/coveralls/bin/coveralls.js",
|
||||||
"doc": "jsdoc *.js --destination ./docs --private --readme ./readme.md --template ./node_modules/docdash"
|
"docs": "jsdoc *.js -c ./jsdoc.json; jsdoc2md --template ./jsdoc2md/api.hbs --files *.js > ./docs/api.md; docco --output ./docs/docco --layout plain-markdown *.js && mv ./docs/docco/index.html ./docs/docco/README.md; docco --output ./docs/docco *.js",
|
||||||
|
"jsdoc": "jsdoc *.js -c ./jsdoc.json",
|
||||||
|
"readme": "jsdoc2md --template ./jsdoc2md/api.hbs --files *.js > ./docs/api.md",
|
||||||
|
"docco": "docco --output ./docs/docco --layout plain-markdown *.js && mv ./docs/docco/index.html ./docs/docco/README.md; docco --output ./docs/docco *.js"
|
||||||
},
|
},
|
||||||
"jest": {
|
"jest": {
|
||||||
"collectCoverage": true,
|
"collectCoverage": true,
|
||||||
|
|||||||
Loading…
x
Reference in New Issue
Block a user