registry-auth-token

Get the auth token set for an npm registry from .npmrc. Also allows fetching the configured registry URL for a given npm scope.

Installing

npm install --save registry-auth-token

Usage

Returns an object containing token and type, or undefined if no token can be found. type can be either Bearer or Basic.

1const getAuthToken = require('registry-auth-token')
2const getRegistryUrl = require('registry-auth-token/registry-url')
3
4// Get auth token and type for default `registry` set in `.npmrc`
5console.log(getAuthToken()) // {token: 'someToken', type: 'Bearer'}
6
7// Get auth token for a specific registry URL
8console.log(getAuthToken('//registry.foo.bar'))
9
10// Find the registry auth token for a given URL (with deep path):
11// If registry is at `//some.host/registry`
12// URL passed is `//some.host/registry/deep/path`
13// Will find token the closest matching path; `//some.host/registry`
14console.log(getAuthToken('//some.host/registry/deep/path', {recursive: true}))
15
16// Use the npm config that is passed in
17console.log(getAuthToken('//registry.foo.bar', {
18  npmrc: {
19    'registry': 'http://registry.foo.bar',
20    '//registry.foo.bar/:_authToken': 'qar'
21  }
22}))
23
24// Find the configured registry url for scope `@foobar`.
25// Falls back to the global registry if not defined.
26console.log(getRegistryUrl('@foobar'))
27
28// Use the npm config that is passed in
29console.log(getRegistryUrl('http://registry.foobar.eu/', {
30  'registry': 'http://registry.foobar.eu/',
31  '//registry.foobar.eu/:_authToken': 'qar'
32}))

Return value

1// If auth info can be found:
2{token: 'someToken', type: 'Bearer'}
3
4// Or:
5{token: 'someOtherToken', type: 'Basic'}
6
7// Or, if nothing is found:
8undefined

Security

Please be careful when using this. Leaking your auth token is dangerous.

License

MIT © Espen Hovlandsdal