os-locale-s
v1.0.26
Published
Its a light weight version that minimizes the dependency module of `os-locale`
Downloads
11,700
Maintainers
Readme
OS locale detector (os-locale-s)
Its a light weight version that minimizes the dependency module of 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.
Motivacion
I was creating a module package and needed to detect the locale.
At that time, I found a module os-locale
that provides the corresponding function in the npm package.
I just wanted to detect locale token such as "cs", "de", "es", "fr" etc butos-locale
installs as many as 27 npm packages, including indirectly dependent modules
- e.g -
yarn add os-locale
I just wanted to detect a simple locale token but thought this was overwork and decided to rewrite the code.
At the same time, has been migrate to TypeScript
as well.
As a result, the number of npm packages installed in
os-locale-s
has been reduced to 3 includingos-locale-s
Install
$ npm install os-locale-s
Usage
// node (commenjs)
const { osLocale } = require("os-locale-s");
(async () => {
console.log(await osLocale());
//=> 'en-US'
})();
// ECMA module
import { osLocale } from "os-locale-s";
(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. (process.env
)
cache
Type: boolean
Default: true
Once the locale is detected, its value is retained and reused at the second and subsequent detections.
If set to false
, the last held value will be ignored and do locale detection again (and the resulting value is not preserved)