[basic-auth] Copy jsdoc

This commit is contained in:
Vesa Poikajärvi
2017-05-21 18:48:23 +03:00
parent 99f3e10a1d
commit bb60981e52
2 changed files with 8 additions and 2 deletions

View File

@@ -3,4 +3,4 @@ import auth = require('basic-auth');
auth(null);
auth.parse('QmFzaWM6QXV0aA==');
auth.parse('Basic QmFzaWM6QXV0aA==');

View File

@@ -15,7 +15,13 @@ declare namespace auth {
pass: string;
}
// See https://github.com/jshttp/basic-auth/blob/v1.1.0/index.js#L87-L95
/**
* Parse basic auth to object.
*
* @param {string} string
* @return {object}
* @public
*/
function parse(authorizationHeader: string): auth.BasicAuthResult | undefined;
}