Blame view

node_modules/os-locale/readme.md 1 KB
aaac7fed   liuqimichale   add
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
  # os-locale [![Build Status](https://travis-ci.org/sindresorhus/os-locale.svg?branch=master)](https://travis-ci.org/sindresorhus/os-locale)
  
  > Get the system [locale](http://en.wikipedia.org/wiki/Locale)
  
  Useful for localizing your module or app.
  
  POSIX systems: The returned locale refers to the [`LC_MESSAGE`](http://www.gnu.org/software/libc/manual/html_node/Locale-Categories.html#Locale-Categories) category, suitable for selecting the language used in the user interface for message translation.
  
  
  ## Install
  
  ```
  $ npm install --save os-locale
  ```
  
  
  ## Usage
  
  ```js
  var osLocale = require('os-locale');
  
  osLocale(function (err, locale) {
  	console.log(locale);
  	//=> 'en_US'
  });
  ```
  
  
  ## API
  
  ### osLocale([options], callback(error, locale))
  
  ### osLocale.sync([options])
  
  Returns the locale.
  
  #### options.spawn
  
  Type: `boolean`  
  Default: `true`
  
  Set to `false` to avoid spawning subprocesses and instead only resolve the locale from environment variables.
  
  
  ## License
  
  MIT © [Sindre Sorhus](http://sindresorhus.com)