From 2cb30e652d2e93907064f13b65e51fb749f46af4 Mon Sep 17 00:00:00 2001
From: ajimix
Date: Fri, 22 Mar 2019 12:18:56 +0800
Subject: [PATCH] Fix applicationName typo
---
README.md | 4 ++--
docs/api.md | 4 ++--
docs/docco/README.md | 12 ++++++------
docs/docco/index.html | 12 ++++++------
docs/index.html | 4 ++--
docs/index.js.html | 12 ++++++------
docs/module-SyslogPro-RFC3164.html | 2 +-
docs/module-SyslogPro-RFC5424.html | 2 +-
index.js | 21 ++++++++++++++-------
9 files changed, 40 insertions(+), 33 deletions(-)
diff --git a/README.md b/README.md
index 8624407..2296605 100644
--- a/README.md
+++ b/README.md
@@ -50,7 +50,7 @@ create formatted messages or use directly
**RFC3164**
```js
let rfc3164 = new SyslogPro.RFC3164({
- applacationName: 'MyApp',
+ applicationName: 'MyApp',
color: true,
extendedColor: true,
server: {
@@ -63,7 +63,7 @@ create formatted messages or use directly
**RFC5424**
```js
let rfc5424 = new SyslogPro.RFC5424({
- applacationName: 'MyApp',
+ applicationName: 'MyApp',
timestamp: true,
encludeStructuredData: true
color: true,
diff --git a/docs/api.md b/docs/api.md
index 9d4ec74..6e7600e 100644
--- a/docs/api.md
+++ b/docs/api.md
@@ -263,7 +263,7 @@ Construct a new RFC3164 formatted Syslog object with user options
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | object
| | Options object |
-| [options.applacationName] | string
| "'NodeJSLogger'"
| Application |
+| [options.applicationName] | string
| "'NodeJSLogger'"
| Application |
| [options.hostname] | string
| "os.hostname"
| The name of this server |
| [options.facility] | number
| 23
| Facility code to use sending this message |
| [options.color] | boolean
| false
| Apply color coding encoding tag with syslog message text |
@@ -668,7 +668,7 @@ Construct a new RFC5424 formatted Syslog object with user options
| Param | Type | Default | Description |
| --- | --- | --- | --- |
| [options] | object
| | Options object |
-| [options.applacationName] | string
| "'NodeJSLogger'"
| Application |
+| [options.applicationName] | string
| "'NodeJSLogger'"
| Application |
| [options.hostname] | string
| "os.hostname"
| The name of this server |
| [options.timestamp] | boolean
| false
| Included a Timestamp |
| [options.timestampUTC] | boolean
| false
| RFC standard is for local time |
diff --git a/docs/docco/README.md b/docs/docco/README.md
index 11bd0b2..1856f2f 100644
--- a/docs/docco/README.md
+++ b/docs/docco/README.md
@@ -624,7 +624,7 @@ class RFC3164 {
* @public
* @this RFC3164
* @param {object} [options] - Options object
- * @param {string} [options.applacationName='NodeJSLogger'] - Application
+ * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server
* @param {number} [options.facility=23] - Facility code to use sending this
* message
@@ -667,7 +667,7 @@ class RFC3164 {
this.constructor__ = true;
options = options || {};
this.hostname = options.hostname || os.hostname();
- this.applacationName = options.applacationName || '';
+ this.applicationName = options.applicationName || '';
this.facility = options.facility || 23;
if (options.color) {
/** @type {boolean} */
@@ -1016,7 +1016,7 @@ Build message
fmtMsg = '<' + pri + '>';
fmtMsg += timestamp;
fmtMsg += ' ' + this.hostname;
- fmtMsg += ' ' + this.applacationName;
+ fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + msg;
fmtMsg += newLine;
resolve(fmtMsg);
@@ -1258,7 +1258,7 @@ class RFC5424 {
* @public
* @this RFC5424
* @param {object} [options] - Options object
- * @param {string} [options.applacationName='NodeJSLogger'] - Application
+ * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server
* @param {boolean} [options.timestamp=false] - Included a Timestamp
* @param {boolean} [options.timestampUTC=false] - RFC standard is for
@@ -1308,7 +1308,7 @@ class RFC5424 {
this.constructor__ = true;
options = options || {};
this.hostname = options.hostname || os.hostname();
- this.applacationName = options.applacationName || '';
+ this.applicationName = options.applicationName || '';
if (typeof options.timestamp === 'undefined' || options.timestamp) {
/** @type {boolean} */
this.timestamp = true;
@@ -1791,7 +1791,7 @@ Build the message
fmtMsg += '1'; // Version number
fmtMsg += ' ' + timestamp;
fmtMsg += ' ' + this.hostname;
- fmtMsg += ' ' + this.applacationName;
+ fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + pid;
fmtMsg += ' ' + id;
fmtMsg += ' ' + structuredData;
diff --git a/docs/docco/index.html b/docs/docco/index.html
index 79d0595..4adfe23 100644
--- a/docs/docco/index.html
+++ b/docs/docco/index.html
@@ -637,7 +637,7 @@
* @public
* @this RFC3164
* @param {object} [options] - Options object
- * @param {string} [options.applacationName='NodeJSLogger'] - Application
+ * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server
* @param {number} [options.facility=23] - Facility code to use sending this
* message
@@ -680,7 +680,7 @@
this.constructor__ = true;
options = options || {};
this.hostname = options.hostname || os.hostname();
- this.applacationName = options.applacationName || '';
+ this.applicationName = options.applicationName || '';
this.facility = options.facility || 23;
if (options.color) {
@@ -1024,7 +1024,7 @@ uses BSD timeformat
fmtMsg = '<' + pri + '>';
fmtMsg += timestamp;
fmtMsg += ' ' + this.hostname;
- fmtMsg += ' ' + this.applacationName;
+ fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + msg;
fmtMsg += newLine;
resolve(fmtMsg);
@@ -1266,7 +1266,7 @@ uses BSD timeformat
* @public
* @this RFC5424
* @param {object} [options] - Options object
- * @param {string} [options.applacationName='NodeJSLogger'] - Application
+ * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server
* @param {boolean} [options.timestamp=false] - Included a Timestamp
* @param {boolean} [options.timestampUTC=false] - RFC standard is for
@@ -1316,7 +1316,7 @@ uses BSD timeformat
this.constructor__ = true;
options = options || {};
this.hostname = options.hostname || os.hostname();
- this.applacationName = options.applacationName || '';
+ this.applicationName = options.applicationName || '';
if (typeof options.timestamp === 'undefined' || options.timestamp) {
this.timestamp = true;
@@ -1792,7 +1792,7 @@ uses BSD timeformat
fmtMsg += '1';
fmtMsg += ' ' + timestamp;
fmtMsg += ' ' + this.hostname;
- fmtMsg += ' ' + this.applacationName;
+ fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + pid;
fmtMsg += ' ' + id;
fmtMsg += ' ' + structuredData;
diff --git a/docs/index.html b/docs/index.html
index 816d987..78d3fb5 100644
--- a/docs/index.html
+++ b/docs/index.html
@@ -85,7 +85,7 @@ and the DNS Promi
create formatted messages or use directly
RFC3164
let rfc3164 = new SyslogPro.RFC3164({
- applacationName: 'MyApp',
+ applicationName: 'MyApp',
color: true,
extendedColor: true,
server: {
@@ -94,7 +94,7 @@ create formatted messages or use directly
});
rfc3164.info('My Message');
RFC5424
let rfc5424 = new SyslogPro.RFC5424({
- applacationName: 'MyApp',
+ applicationName: 'MyApp',
timestamp: true,
encludeStructuredData: true
color: true,
diff --git a/docs/index.js.html b/docs/index.js.html
index 9f713f4..b6594f7 100644
--- a/docs/index.js.html
+++ b/docs/index.js.html
@@ -518,7 +518,7 @@ class RFC3164 {
* @public
* @this RFC3164
* @param {object} [options] - Options object
- * @param {string} [options.applacationName='NodeJSLogger'] - Application
+ * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server
* @param {number} [options.facility=23] - Facility code to use sending this
* message
@@ -561,7 +561,7 @@ class RFC3164 {
this.constructor__ = true;
options = options || {};
this.hostname = options.hostname || os.hostname();
- this.applacationName = options.applacationName || '';
+ this.applicationName = options.applicationName || '';
this.facility = options.facility || 23;
if (options.color) {
/** @type {boolean} */
@@ -840,7 +840,7 @@ class RFC3164 {
fmtMsg = '<' + pri + '>';
fmtMsg += timestamp;
fmtMsg += ' ' + this.hostname;
- fmtMsg += ' ' + this.applacationName;
+ fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + msg;
fmtMsg += newLine;
resolve(fmtMsg);
@@ -1082,7 +1082,7 @@ class RFC5424 {
* @public
* @this RFC5424
* @param {object} [options] - Options object
- * @param {string} [options.applacationName='NodeJSLogger'] - Application
+ * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server
* @param {boolean} [options.timestamp=false] - Included a Timestamp
* @param {boolean} [options.timestampUTC=false] - RFC standard is for
@@ -1132,7 +1132,7 @@ class RFC5424 {
this.constructor__ = true;
options = options || {};
this.hostname = options.hostname || os.hostname();
- this.applacationName = options.applacationName || '';
+ this.applicationName = options.applicationName || '';
if (typeof options.timestamp === 'undefined' || options.timestamp) {
/** @type {boolean} */
this.timestamp = true;
@@ -1517,7 +1517,7 @@ class RFC5424 {
fmtMsg += '1'; // Version number
fmtMsg += ' ' + timestamp;
fmtMsg += ' ' + this.hostname;
- fmtMsg += ' ' + this.applacationName;
+ fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + pid;
fmtMsg += ' ' + id;
fmtMsg += ' ' + structuredData;
diff --git a/docs/module-SyslogPro-RFC3164.html b/docs/module-SyslogPro-RFC3164.html
index 06ba0aa..fbb3a0a 100644
--- a/docs/module-SyslogPro-RFC3164.html
+++ b/docs/module-SyslogPro-RFC3164.html
@@ -229,7 +229,7 @@ fashion where new messages are written to the class as needed.
- applacationName |
+ applicationName |
diff --git a/docs/module-SyslogPro-RFC5424.html b/docs/module-SyslogPro-RFC5424.html
index 14c9809..b4ed0ad 100644
--- a/docs/module-SyslogPro-RFC5424.html
+++ b/docs/module-SyslogPro-RFC5424.html
@@ -230,7 +230,7 @@ fashion where new messages are written to the class as needed.
|
- applacationName |
+ applicationName |
diff --git a/index.js b/index.js
index fb2c443..c811e0a 100644
--- a/index.js
+++ b/index.js
@@ -475,7 +475,7 @@ class RFC3164 {
* @public
* @this RFC3164
* @param {object} [options] - Options object
- * @param {string} [options.applacationName='NodeJSLogger'] - Application
+ * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server
* @param {number} [options.facility=23] - Facility code to use sending this
* message
@@ -518,7 +518,11 @@ class RFC3164 {
this.constructor__ = true;
options = options || {};
this.hostname = options.hostname || os.hostname();
- this.applacationName = options.applacationName || '';
+ if (options.applicationName) {
+ this.applicationName = options.applicationName;
+ } else {
+ this.applicationName = options.applacationName || '';
+ }
this.facility = options.facility || 23;
if (options.color) {
/** @type {boolean} */
@@ -797,7 +801,7 @@ class RFC3164 {
fmtMsg = '<' + pri + '>';
fmtMsg += timestamp;
fmtMsg += ' ' + this.hostname;
- fmtMsg += ' ' + this.applacationName;
+ fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + msg;
fmtMsg += newLine;
resolve(fmtMsg);
@@ -1039,7 +1043,7 @@ class RFC5424 {
* @public
* @this RFC5424
* @param {object} [options] - Options object
- * @param {string} [options.applacationName='NodeJSLogger'] - Application
+ * @param {string} [options.applicationName='NodeJSLogger'] - Application
* @param {string} [options.hostname=os.hostname] - The name of this server
* @param {boolean} [options.timestamp=false] - Included a Timestamp
* @param {boolean} [options.timestampUTC=false] - RFC standard is for
@@ -1089,7 +1093,11 @@ class RFC5424 {
this.constructor__ = true;
options = options || {};
this.hostname = options.hostname || os.hostname();
- this.applacationName = options.applacationName || '';
+ if (options.applicationName) {
+ this.applicationName = options.applicationName;
+ } else {
+ this.applicationName = options.applacationName || '';
+ }
if (typeof options.timestamp === 'undefined' || options.timestamp) {
/** @type {boolean} */
this.timestamp = true;
@@ -1474,7 +1482,7 @@ class RFC5424 {
fmtMsg += '1'; // Version number
fmtMsg += ' ' + timestamp;
fmtMsg += ' ' + this.hostname;
- fmtMsg += ' ' + this.applacationName;
+ fmtMsg += ' ' + this.applicationName;
fmtMsg += ' ' + pid;
fmtMsg += ' ' + id;
fmtMsg += ' ' + structuredData;
@@ -3374,4 +3382,3 @@ module.exports = {
CEF: CEF,
Syslog: Syslog,
};
-
|