Skip to content

Commit dba27f3

Browse files
committed
docs(passport): add clarity to oauth-specific AuthenticateOptions
1 parent afe24ae commit dba27f3

File tree

1 file changed

+21
-2
lines changed

1 file changed

+21
-2
lines changed

src/passport.ts

Lines changed: 21 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,25 @@ export interface AuthenticateOptions extends passport.AuthenticateOptions {
5151
authorizationDetails?:
5252
| client.AuthorizationDetails
5353
| client.AuthorizationDetails[]
54+
55+
/**
56+
* OpenID Connect prompt. This will be used as the `prompt` authorization
57+
* request parameter unless specified through other means.
58+
*/
59+
prompt?: string
60+
61+
/**
62+
* OAuth 2.0 scope to use for the authorization request. It is ignored for
63+
* token endpoint requests.
64+
*/
65+
scope?: string | string[]
66+
67+
/**
68+
* The state option is ignored by this strategy.
69+
*
70+
* @deprecated
71+
*/
72+
state?: never
5473
}
5574

5675
/**
@@ -88,8 +107,8 @@ interface StrategyOptionsBase {
88107
*/
89108
callbackURL?: string
90109
/**
91-
* Authorization Request Scope. This will be used as the `scope` authorization
92-
* request parameter unless specified elsewhere.
110+
* OAuth 2.0 Authorization Request Scope. This will be used as the `scope`
111+
* authorization request parameter unless specified through other means.
93112
*/
94113
scope?: string
95114
/**

0 commit comments

Comments
 (0)