Skip to content

Commit d615b4e

Browse files
committed
docs: rename token to _authToken
1 parent 847e5f9 commit d615b4e

File tree

1 file changed

+3
-12
lines changed

1 file changed

+3
-12
lines changed

README.md

+3-12
Original file line numberDiff line numberDiff line change
@@ -581,9 +581,8 @@ See also [`opts.ca`](#opts-ca).
581581

582582
Time before a hanging request times out.
583583

584-
##### <a name="opts-token"></a> `opts.token`
584+
##### <a name="opts-authtoken"></a> `opts._authToken`
585585

586-
* Alias: `opts._authToken`
587586
* Type: String
588587
* Default: null
589588

@@ -593,7 +592,7 @@ Can be scoped to a registry by using a "nerf dart" for that registry. That is:
593592

594593
```
595594
{
596-
'//registry.npmjs.org/:token': 't0k3nH34r'
595+
'//registry.npmjs.org/:_authToken': 't0k3nH34r'
597596
}
598597
```
599598

@@ -610,7 +609,7 @@ User agent string to send in the `User-Agent` header.
610609
* Default: null
611610

612611
Username used for basic authentication. For the more modern authentication
613-
method, please use the (more secure) [`opts.token`](#opts-token)
612+
method, please use the (more secure) [`opts.authtoken`](#opts-authtoken)
614613

615614
Can optionally be scoped to a registry by using a "nerf dart" for that registry.
616615
That is:
@@ -622,11 +621,3 @@ That is:
622621
```
623622

624623
See also [`opts.password`](#opts-password)
625-
626-
##### <a name="opts-auth"></a> `opts._auth`
627-
628-
* Type: String
629-
* Default: null
630-
631-
** DEPRECATED ** This is a legacy authentication token supported only for
632-
compatibility. Please use [`opts.token`](#opts-token) instead.

0 commit comments

Comments
 (0)