node_modules/os-locale/readme.md

In thisisnic/starrating: What the Package Does (One Line, Title Case)

os-locale

Get the system locale

Useful for localizing your module or app.

POSIX systems: The returned locale refers to the LC_MESSAGE category, suitable for selecting the language used in the user interface for message translation.

Get professional support for 'os-locale' with a Tidelift subscription Tidelift helps make open source sustainable for maintainers while giving companiesassurances about security, maintenance, and licensing for their dependencies.

Install

$ npm install os-locale

Usage

const osLocale = require('os-locale');

(async () => {
    console.log(await osLocale());
    //=> 'en_US'
})();

API

osLocale([options])

Returns a Promise for the locale.

osLocale.sync([options])

Returns the locale.

options

Type: Object

spawn

Type: boolean Default: true

Set to false to avoid spawning subprocesses and instead only resolve the locale from environment variables.

Security

To report a security vulnerability, please use the Tidelift security contact. Tidelift will coordinate the fix and disclosure.

License

MIT © Sindre Sorhus

thisisnic/starrating documentation built on May 18, 2019, 1:32 p.m.