https://github.com/sindresorhus/macos-release

Get the name and version of a macOS release from the Darwin version
https://github.com/sindresorhus/macos-release

Last synced: 5 days ago
JSON representation

Get the name and version of a macOS release from the Darwin version

• Host: GitHub
• URL: https://github.com/sindresorhus/macos-release
• Owner: sindresorhus
• License: mit
• Created: 2014-06-08T15:37:59.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2024-07-31T16:03:15.000Z (4 months ago)
• Last Synced: 2024-11-30T18:25:50.118Z (12 days ago)
• Language: JavaScript
• Homepage:
• Size: 29.3 KB
• Stars: 64
• Watchers: 8
• Forks: 17
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• my-awesome - sindresorhus/macos-release - 07 star:0.1k fork:0.0k Get the name and version of a macOS release from the Darwin version (JavaScript)

README

        
# macos-release

> Get the name and version of a macOS release from the Darwin version\

> Example: `13.2.0` → `{name: 'Mavericks', version: '10.9'}`

## Install

```sh

npm install macos-release

```

## Usage

```js

import os from 'node:os';

import macosRelease from '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'}

macosRelease('20.0.0');

//=> {name: 'Big Sur', version: '11'}

```

## API

### macosRelease(release?)

#### release

Type: `string`

By default, the current operating system is used, but you can supply a custom [Darwin kernel version](https://en.wikipedia.org/wiki/Darwin_%28operating_system%29#Release_history), which is the output of [`os.release()`](https://nodejs.org/api/os.html#os_os_release).

## Related

- [os-name](https://github.com/sindresorhus/os-name) - Get the name of the current operating system. Example: `macOS Sierra`

- [macos-version](https://github.com/sindresorhus/macos-version) - Get the macOS version of the current system. Example: `10.9.3`

- [windows-release](https://github.com/sindresorhus/windows-release) - Get the name of a Windows version from the release number: `5.1.2600` → `XP`