Update comments

This commit is contained in:
Sam Frances 2017-05-05 15:00:31 +01:00
parent c6d7444388
commit 22ffd2c670
1 changed files with 4 additions and 4 deletions

View File

@ -47,8 +47,8 @@ function urlTokenMatch(url, token, verbose=false) {
exports.tokenAuth = function tokenAuth(source) { exports.tokenAuth = function tokenAuth(source) {
/** /**
* Authorisation plugin which validates the token query parameter against * Authorisation plugin which validates the token query parameter against
* a token provided as the argument to the --auth-source command line * a token provided as the argument to the `--auth-source` command line
* argument * argument.
*/ */
return function(info) { return function(info) {
let token = source; let token = source;
@ -61,7 +61,7 @@ exports.tokenAuthEnv = function tokenAuthEnv(source) {
* Authorisation plugin which validates the token query parameter against * Authorisation plugin which validates the token query parameter against
* a token which is the value of an environment variable. The name of this * a token which is the value of an environment variable. The name of this
* environment variable is specified as the argument to the command line * environment variable is specified as the argument to the command line
* argument --auth-source * argument `--auth-source`
*/ */
return function(info) { return function(info) {
let token = process.env[source]; let token = process.env[source];
@ -73,7 +73,7 @@ exports.tokenAuthFile = function tokenEnvFile(source) {
/** /**
* Authorisation plugin which validates the token query parameter against a * Authorisation plugin which validates the token query parameter against a
* token which is contained in a text file, the path to which is specified * token which is contained in a text file, the path to which is specified
* as the value of the --auth-source command line argument * as the value of the `--auth-source` command line argument
*/ */
return function(info, cb) { return function(info, cb) {
fs.readFile(source, 'utf8', function(err, data) { fs.readFile(source, 'utf8', function(err, data) {