github-pages-deploy-action/node_modules/macos-release/readme.md
2020-01-28 00:07:56 -05:00

1.5 KiB

macos-release Build Status

Get the name and version of a macOS release from the Darwin version
Example: 13.2.0{name: 'Mavericks', version: '10.9'}

Install

$ npm install macos-release

Usage

const os = require('os');
const macosRelease = require('macos-release');

// On a macOS Sierra system

macosRelease();
//=> {name: 'Sierra', version: '10.12'}

os.release();
//=> 13.2.0
// This is the Darwin kernel version

macosRelease(os.release());
//=> {name: 'Sierra', version: '10.12'}

macosRelease('14.0.0');
//=> {name: 'Yosemite', version: '10.10'}

API

macosRelease([release])

release

Type: string

By default, the current operating system is used, but you can supply a custom Darwin kernel version, which is the output of os.release().

  • os-name - Get the name of the current operating system. Example: macOS Sierra
  • macos-version - Get the macOS version of the current system. Example: 10.9.3
  • win-release - Get the name of a Windows version from the release number: 5.1.2600XP

License

MIT © Sindre Sorhus