History

Theunis J. Botha 5f5bbac56e initial comit		2020-02-27 15:24:35 +01:00
..
index.js	initial comit	2020-02-27 15:24:35 +01:00
license	initial comit	2020-02-27 15:24:35 +01:00
package.json	initial comit	2020-02-27 15:24:35 +01:00
readme.md	initial comit	2020-02-27 15:24:35 +01:00

readme.md

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 companies
assurances 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.