mirror of https://github.com/actions/setup-node.git synced 2024-09-19 16:06:43 +00:00

History

Danny McCormick 5273d0df9c Add auth		2019-08-06 18:29:44 -04:00
..
index.d.ts	Add auth	2019-08-06 18:29:44 -04:00
index.js	Add auth	2019-08-06 18:29:44 -04:00
license	Add auth	2019-08-06 18:29:44 -04:00
package.json	Add auth	2019-08-06 18:29:44 -04:00
readme.md	Add auth	2019-08-06 18:29:44 -04:00

readme.md

os-name

Get the name of the current operating system
Example: macOS Sierra

Useful for analytics and debugging.

Install

$ npm install os-name

Usage

const os = require('os');
const osName = require('os-name');

// On a macOS Sierra system

osName();
//=> 'macOS Sierra'

osName(os.platform(), os.release());
//=> 'macOS Sierra'

osName('darwin', '14.0.0');
//=> 'OS X Yosemite'

osName('linux', '3.13.0-24-generic');
//=> 'Linux 3.13'

osName('win32', '6.3.9600');
//=> 'Windows 8.1'

API

osName([platform, release])

By default, the name of the current operating system is returned.

You can optionally supply a custom os.platform() and os.release().

Check out getos if you need the Linux distribution name.

Contributing

Production systems depend on this package for logging / tracking. Please be careful when introducing new output, and adhere to existing output format (whitespace, capitalization, etc.).

os-name-cli - CLI for this module