os-locale

What is os-locale?

The os-locale npm package is a utility for getting the system locale information. It is primarily used to determine the locale setting of the operating system where the Node.js application is running. This can be useful for applications that need to perform locale-specific operations, such as formatting dates, numbers, or strings according to the user's regional settings.

What are os-locale's main functionalities?

Get system locale

This feature allows you to asynchronously retrieve the system's current locale setting. The locale is returned as a string, such as 'en-US' for English (United States).

const osLocale = require('os-locale');
osLocale().then(locale => {
  console.log(locale);
});

Get system locale synchronously

This feature provides a synchronous method to get the system locale. This can be useful in scenarios where asynchronous execution may not be ideal.

const osLocale = require('os-locale');
const locale = osLocale.sync();
console.log(locale);

Other packages similar to os-locale

system-locale

The system-locale package also provides functionality to detect the system's locale. It is similar to os-locale but does not offer a synchronous method, which might make os-locale preferable in scenarios where immediate locale detection is necessary without the complexities of asynchronous code.

locale2

Locale2 is another npm package that can be used to get the user's locale. Unlike os-locale, locale2 also tries to detect the locale from the browser environment when used in web contexts, making it a more versatile choice for projects that span both node and browser environments.

README

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 os-locale

Usage

import {osLocale} from 'os-locale';

console.log(await osLocale());
//=> 'en-US'

API

osLocale(options?)

Returns a Promise for the locale.

osLocaleSync(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.

os-locale for enterprise

Available as part of the Tidelift Subscription.

The maintainers of os-locale and thousands of other packages are working with Tidelift to deliver commercial support and maintenance for the open source dependencies you use to build your applications. Save time, reduce risk, and improve code health, while paying the maintainers of the exact dependencies you use. Learn more.