From d615b4e6cf284c4a8f39b24700beacbf07dfec5d Mon Sep 17 00:00:00 2001 From: Gar Date: Wed, 9 Feb 2022 08:48:19 -0800 Subject: [PATCH] docs: rename token to _authToken --- README.md | 15 +++------------ 1 file changed, 3 insertions(+), 12 deletions(-) diff --git a/README.md b/README.md index b0e064b..279f75a 100644 --- a/README.md +++ b/README.md @@ -581,9 +581,8 @@ See also [`opts.ca`](#opts-ca). Time before a hanging request times out. -##### `opts.token` +##### `opts._authToken` -* Alias: `opts._authToken` * Type: String * Default: null @@ -593,7 +592,7 @@ Can be scoped to a registry by using a "nerf dart" for that registry. That is: ``` { - '//registry.npmjs.org/:token': 't0k3nH34r' + '//registry.npmjs.org/:_authToken': 't0k3nH34r' } ``` @@ -610,7 +609,7 @@ User agent string to send in the `User-Agent` header. * Default: null Username used for basic authentication. For the more modern authentication -method, please use the (more secure) [`opts.token`](#opts-token) +method, please use the (more secure) [`opts.authtoken`](#opts-authtoken) Can optionally be scoped to a registry by using a "nerf dart" for that registry. That is: @@ -622,11 +621,3 @@ That is: ``` See also [`opts.password`](#opts-password) - -##### `opts._auth` - -* Type: String -* Default: null - -** DEPRECATED ** This is a legacy authentication token supported only for -compatibility. Please use [`opts.token`](#opts-token) instead.