Skip to content

Commit a479713

Browse files
committed
Revise Authenticator#authorize docs.
1 parent 4f0df36 commit a479713

File tree

1 file changed

+7
-7
lines changed

1 file changed

+7
-7
lines changed

lib/authenticator.js

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -188,14 +188,14 @@ Authenticator.prototype.authenticate = function(strategy, options, callback) {
188188
* be left unmodified. A route handler can then link the third-party account to
189189
* the existing local account.
190190
*
191-
* Examples:
192-
*
193-
* passport.authorize('twitter-authz', { failureRedirect: '/account' });
191+
* All arguments to this function behave identically to those accepted by
192+
* `{@link Authenticator#authenticate}`.
194193
*
195-
* @param {String} strategy
196-
* @param {Object} options
197-
* @return {Function} middleware
198-
* @api public
194+
* @public
195+
* @param {string|string[]|Strategy} strategy
196+
* @param {Object} [options]
197+
* @param {function} [callback]
198+
* @returns {function}
199199
*
200200
* @example
201201
* app.get('/oauth/callback/twitter', passport.authorize('twitter'));

0 commit comments

Comments
 (0)