mirror of https://github.com/nodejs/node.git synced 2024-12-01 16:10:02 +01:00

History

…
..
index.js
license
package.json
readme.md

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.

Install

$ npm install --save os-locale

Usage

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

osLocale().then(locale => {
	console.log(locale);
	//=> '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.