index.d.ts
773 Bytes
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
declare namespace osLocale {
interface Options {
/**
Set to `false` to avoid spawning subprocesses and instead only resolve the locale from environment variables.
@default true
*/
readonly spawn?: boolean;
}
}
declare const osLocale: {
/**
Get the system [locale](https://en.wikipedia.org/wiki/Locale_(computer_software)).
@returns The locale.
@example
```
import osLocale = require('@umijs/deps/types/os-locale/os-locale');
(async () => {
console.log(await osLocale());
//=> 'en-US'
})();
```
*/
(options?: osLocale.Options): Promise<string>;
/**
Synchronously get the system [locale](https://en.wikipedia.org/wiki/Locale_(computer_software)).
@returns The locale.
*/
sync(options?: osLocale.Options): string;
};
export = osLocale;