Cleanup middleware config opts

[bajtos]

Rename config.config to config.params, as that better describes the purpose of the property, which is to pass arguments to the middleware factory function.

Improve jsdoc comments.

/to @ritch please review
/cc @raymondfeng

[bajtos]

Note: lib/server-app.js is not included in the apidocs yet, see strongloop/strong-docs#57

[bajtos]

@ritch args is weird... It hints at a function call which is a bit odd in a config file. Although I'm not 100% against it since we get the same behavior.

While most middleware factories accepts a single "options" argument, there are exceptions like morgan(format, options) that need multiple arguments.

@raymondfeng suggested options in a comment elsewhere. Initially I thought it is a good candidate, but now that I look at morgan(format, options) as described in morgan docs, I think it would be confusing for users.

Let's explore few alternatives.

{
"morgan-1": {
"args": ["dev", { "immediate": true }]
},
"morgan-2": {
"params": ["dev", { "immediate": true }]
},
"morgan-3": {
"config": [ "dev", { "immediate": true }]
}
}

Perhaps params is a good name, since it can be interpreted both as a list of arguments (params: [1, 2]) and an options object (params: { foo: 1, bar: 2 }).

{
"morgan": {
"params": ["dev", { "immediate": true }]
},
"compression": {
"params": { "threshold": 128 }
}
}

Thoughts?

[bajtos]

I have reworked the patch to use params instead of args. If we agree that params is a good name, then this PR is ready for final review and merge.

[bajtos]

@ritch ping

[ritch]

👍