Skip to content

Commit 40bcd65

Browse files
committed
fix(docs): document opts.forceAuth
1 parent 6923702 commit 40bcd65

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

Diff for: README.md

+10
Original file line numberDiff line numberDiff line change
@@ -214,6 +214,16 @@ packages.
214214
See also [`opts.retry`](#opts-retry) to provide all retry options as a single
215215
object.
216216

217+
##### <a name="opts-force-auth"></a> `opts.force-auth`
218+
219+
* Alias: `opts.forceAuth`
220+
* Type: Object
221+
* Default: null
222+
223+
If present, other auth-related values in `opts` will be completely ignored,
224+
including `alwaysAuth`, `email`, and `otp`, when calculating auth for a request,
225+
and the auth details in `opts.forceAuth` will be used instead.
226+
217227
##### <a name="opts-gzip"></a> `opts.gzip`
218228

219229
* Type: Boolean

0 commit comments

Comments
 (0)