1
0
Fork 0
mirror of https://github.com/actions/setup-node synced 2024-11-10 07:32:40 +00:00
setup-node/node_modules/windows-release/readme.md
Danny McCormick 78148dae50
Add auth support (#21)
* Updates

* Update

* Update

* Update

* Update

* Yarn sometimes prefers npmrc, so use same token

* Description

* Update readme

* Feedback

* Add type

* new toolkit and scoped registries

* npmrc in RUNNER_TEMP

* Dont always auth

* Try exporting blank token

* Get auth working for now pending runner changes

* Fix string interpolation for auth token.

* Don't export both userconfigs

* Update authutil.js

* Add single quotes for authString

* Fix the registry string.

* Use userconfig and append trailing slash

* Keep in root of repo

* Try just adding auth token

* Remove auth token

* Try changes again

* Add tests

* Npm and GPR samples

* Add types
2019-08-06 18:26:04 -04:00

56 lines
1.3 KiB
Markdown

# windows-release [![Build Status](https://travis-ci.org/sindresorhus/windows-release.svg?branch=master)](https://travis-ci.org/sindresorhus/windows-release)
> Get the name of a Windows version from the release number: `5.1.2600` → `XP`
## Install
```
$ npm install windows-release
```
## Usage
```js
const os = require('os');
const windowsRelease = require('windows-release');
// On a Windows XP system
windowsRelease();
//=> 'XP'
os.release();
//=> '5.1.2600'
windowsRelease(os.release());
//=> 'XP'
windowsRelease('4.9.3000');
//=> 'ME'
```
## API
### windowsRelease([release])
#### release
Type: `string`
By default, the current OS is used, but you can supply a custom release number, which is the output of [`os.release()`](https://nodejs.org/api/os.html#os_os_release).
Note: Most Windows Server versions cannot be detected based on the release number alone. There is runtime detection in place to work around this, but it will only be used if no argument is supplied, or the supplied argument matches `os.release()`.
## Related
- [os-name](https://github.com/sindresorhus/os-name) - Get the name of the current operating system
- [macos-release](https://github.com/sindresorhus/macos-release) - Get the name and version of a macOS release from the Darwin version
## License
MIT © [Sindre Sorhus](https://sindresorhus.com)