'a'

mh-two-thousand-and-two

2024-04-12 44d2c92345cd156a59fc327b3060292a282d2893

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
48
49
50
51
52
53
54
55
56
57
58
59
//
// Copyright (c) Sindre Sorhus <sindresorhus@gmail.com> (https://sindresorhus.com)
// Released under the MIT license
// https://opensource.org/licenses/mit-license.php
//
/*!
 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
  Copyright (C) 2020 jeffy-g <hirotom1107@gmail.com>
  Released under the MIT license
  https://opensource.org/licenses/mit-license.php
 - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -
*/
export declare interface LocaleDetectorOptions {
    /**
     * Set to `false` to avoid spawning subprocesses and instead only resolve the locale from environment variables.
     * 
     * @default true
     */
    readonly spawn?: boolean;
    /**
     * @default true
     */
    readonly cache?: boolean;
}
export declare interface LocaleDetectorBase {
    /**
     * Get the system [locale](https://en.wikipedia.org/wiki/Locale_(computer_software)).
     * 
     * @returns The locale.
     * 
     * @example
     * ```
     * import { osLocale } = require("os-locale-s");
         * 
     * (async () => {
     *     console.log(await osLocale());
     *     //=> 'en-US'
     * })();
     * ```
     */
    (options?: LocaleDetectorOptions): Promise<string>;
    /**
     *
     */
    readonly version: string;
}
 
export declare interface LocaleDetector extends LocaleDetectorBase {
    /**
     * Synchronously get the system [locale](https://en.wikipedia.org/wiki/Locale_(computer_software)).
     * 
     * @returns The locale.
     */
    sync(options?: LocaleDetectorOptions): string;
}
 
export declare const osLocale: LocaleDetector;
 
export as namespace NsOsLocale;