https://github.com/rexxars/registry-auth-token

Get the auth token set for an npm registry
https://github.com/rexxars/registry-auth-token

Last synced: 13 days ago
JSON representation

Get the auth token set for an npm registry

• Host: GitHub
• URL: https://github.com/rexxars/registry-auth-token
• Owner: rexxars
• License: mit
• Created: 2016-03-28T13:16:05.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2024-06-19T23:55:23.000Z (5 months ago)
• Last Synced: 2024-10-18T13:16:12.780Z (26 days ago)
• Language: JavaScript
• Homepage:
• Size: 279 KB
• Stars: 35
• Watchers: 2
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# registry-auth-token

[![npm version](http://img.shields.io/npm/v/registry-auth-token.svg?style=flat-square)](https://www.npmjs.com/package/registry-auth-token)[![npm](https://img.shields.io/npm/dm/registry-auth-token?style=flat-square)](https://www.npmjs.com/package/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`.

```js

const getAuthToken = require('registry-auth-token')

const getRegistryUrl = require('registry-auth-token/registry-url')

// Get auth token and type for default `registry` set in `.npmrc`

console.log(getAuthToken()) // {token: 'someToken', type: 'Bearer'}

// Get auth token for a specific registry URL

console.log(getAuthToken('//registry.foo.bar'))

// Find the registry auth token for a given URL (with deep path):

// If registry is at `//some.host/registry`

// URL passed is `//some.host/registry/deep/path`

// Will find token the closest matching path; `//some.host/registry`

console.log(getAuthToken('//some.host/registry/deep/path', {recursive: true}))

// Use the npm config that is passed in

console.log(getAuthToken('//registry.foo.bar', {

  npmrc: {

    'registry': 'http://registry.foo.bar',

    '//registry.foo.bar/:_authToken': 'qar'

  }

}))

// Find the configured registry url for scope `@foobar`.

// Falls back to the global registry if not defined.

console.log(getRegistryUrl('@foobar'))

// Use the npm config that is passed in

console.log(getRegistryUrl('http://registry.foobar.eu/', {

  'registry': 'http://registry.foobar.eu/',

  '//registry.foobar.eu/:_authToken': 'qar'

}))

```

## Return value

```js

// If auth info can be found:

{token: 'someToken', type: 'Bearer'}

// Or:

{token: 'someOtherToken', type: 'Basic'}

// Or, if nothing is found:

undefined

```

## Security

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

## License

MIT © [Espen Hovlandsdal](https://espen.codes/)