8000 Merge pull request #1004 from wataash/style-param · xaviernoder/log4js-node@fe0713a · GitHub
[go: up one dir, main page]
Skip to content

Commit fe0713a

Browse files
nomiddlenamenomiddlename
authored
Merge pull request log4js-node#1004 from wataash/style-param
style: conform @param to official style
2 parents c830d84 + a81500b commit fe0713a

File tree

5 files changed

+12
-12
lines changed

5 files changed

+12
-12
lines changed

‎lib/LoggingEvent.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ class LoggingEvent {
99
/**
1010
* Models a logging event.
1111
* @constructor
12-
* @param {String} categoryName name of category
12+
* @param {string} categoryName name of category
1313
* @param {Log4js.Level} level level of message
1414
* @param {Array} data objects to log
1515
* @author Seth Chisamore

‎lib/appenders/noLogFilter.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,8 +4,8 @@ const debug = require('debug')('log4js:noLogFilter');
44

55
/**
66
* The function removes empty or null regexp from the array
7-
* @param {Array<string>} regexp
8-
* @returns {Array<string>} a filtered string array with not empty or null regexp
7+
* @param {string[]} regexp
8+
* @returns {string[]} a filtered string array with not empty or null regexp
99
*/
1010
function removeNullOrEmptyRegexp(regexp) {
1111
const filtered = regexp.filter(el => ((el != null) && (el !== '')));
@@ -15,7 +15,7 @@ function removeNullOrEmptyRegexp(regexp) {
1515
/**
1616
* Returns a function that will exclude the events in case they match
1717
* with the regular expressions provided
18-
* @param {string | Array<string>} filters contains the regexp that will be used for the evaluation
18+
* @param {(string|string[])} filters contains the regexp that will be used for the evaluation
1919
* @param {*} appender
2020
* @returns {function}
2121
*/

‎lib/categories.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,8 +10,8 @@ const categories = new Map();
1010
* and level, if none is set on this category.
1111
* This is recursive, so each parent also gets loaded with inherited appenders.
1212
* Inheritance is blocked if a category has inherit=false
13-
* @param {any} config
14-
* @param {any} category the child category
13+
* @param {*} config
14+
* @param {*} category the child category
1515
* @param {string} categoryName dotted path to category
1616
* @return {void}
1717
*/
@@ -57,7 +57,7 @@ function inheritFromParent(config, category, categoryName) {
5757
* Walk all categories in the config, and pull down any configuration from parent to child.
5858
* This includes inherited appenders, and level, where level is not set.
5959
* Inheritance is skipped where a category has inherit=false.
60-
* @param {any} config
60+
* @param {*} config
6161
*/
6262
function addCategoryInheritance(config) {
6363
if (!config.categories) return;

‎lib/connect-logger.js

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ const DEFAULT_FORMAT =
1414
* for the assemble_tokens function at low, to pass the tests.
1515
*
1616
* @param {IncomingMessage} req
17-
* @return {String}
17+
* @return {string}
1818
* @api private
1919
*/
2020
function getUrl(req) {
@@ -111,9 +111,9 @@ function assembleTokens(req, res, customTokens) {
111111
/**
112112
* Return formatted log line.
113113
*
114-
* @param {String} str
114+
* @param {string} str
115115
* @param {Array} tokens
116-
* @return {String}
116+
* @return {string}
117117
* @api private
118118
*/
119119
function format(str, tokens) {
@@ -126,7 +126,7 @@ function format(str, tokens) {
126126
/**
127127
* Return RegExp Object about nolog
128128
*
129-
* @param {String|Array} nolog
129+
* @param {(string|Array)} nolog
130130
* @return {RegExp}
131131
* @api private
132132
*

‎lib/levels.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@ class Level {
2121

2222
/**
2323
* converts given String to corresponding Level
24-
* @param {Level|String} sArg -- String value of Level OR Log4js.Level
24+
* @param {(Level|string)} sArg -- String value of Level OR Log4js.Level
2525
* @param {Level} [defaultLevel] -- default Level, if no String representation
2626
* @return {Level}
2727
*/

0 commit comments

Comments
 (0)
0