Skip to content

shinnn/platform-name

Repository files navigation

platform-name

npm version Build Status codecov

Convert a Node.js platform identifier into a human-readable platform name

const platformName = require('platform-name');

platformName('aix'); //=> 'AIX'
platformName('android'); //=> 'Android'
platformName('darwin'); //=> 'macOS'
platformName('freebsd'); //=> 'FreeBSD'
platformName('linux'); //=> 'Linux'
platformName('openbsd'); //=> 'OpenBSD'
platformName('sunos'); //=> 'Solaris'
platformName('win32'); //=> 'Windows'

Installation

Use npm.

npm install platform-name

API

const platformName = require('platform-name');

platformName([id])

id: string (one of aix android darwin freebsd linux openbsd sunos win32)
Return: string

Uses process.platform when it takes no arguments.

//On macOS

platformName('linux'); //=> 'Linux'
platformName(); //=> 'macOS'

platformName.map

Type: Map<string, string>

ID-name pairs used inside this module.

platformName.map.get('win32'); //=> 'Windows'

License

ISC License © 2018 - 2019 Shinnosuke Watanabe

About

Convert a Node.js platform identifier to the human-readable platform name

Resources

License

Stars

Watchers

Forks

Packages

No packages published