https://github.com/sindresorhus/os-name

Get the name of the current operating system. Example: macOS Sierra
https://github.com/sindresorhus/os-name

Last synced: 29 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/sindresorhus/os-name
• Owner: sindresorhus
• License: mit
• Created: 2014-06-07T22:51:51.000Z (over 10 years ago)
• Default Branch: main
• Last Pushed: 2023-11-24T16:53:42.000Z (12 months ago)
• Last Synced: 2024-03-22T08:07:49.429Z (8 months ago)
• Language: JavaScript
• Homepage:
• Size: 27.3 KB
• Stars: 140
• Watchers: 8
• Forks: 13
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license
  • Security: .github/security.md

Awesome Lists containing this project

• awesome-cross-platform-nodejs - os-name - Get the name of the current operating system. (Libraries / OS identification)
• awesome-nodejs - os-name - Get the name of the current operating system.  (Repository / OS Identification)

README

        
# os-name

> Get the name of the current operating system\

> Example: `macOS Sierra`

Useful for analytics and debugging.

## Install

```sh

npm install os-name

```

## Usage

```js

import os from 'node:os';

import osName from '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()`](https://nodejs.org/api/os.html#os_os_platform) and [`os.release()`](https://nodejs.org/api/os.html#os_os_release).

Check out [`getos`](https://github.com/wblankenship/getos) if you need the Linux distribution name.

## Related

- [os-name-cli](https://github.com/sindresorhus/os-name-cli) - CLI for this module