summaryrefslogtreecommitdiff
path: root/node_modules/bcp-47-normalize/lib/index.d.ts
blob: c1b935f060af5b91b2453155cb05d0fe77bfab73 (plain)
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
/**
 * Normalize the given BCP 47 tag according to Unicode CLDR suggestions.
 *
 * @param {string} tag
 *   BCP 47 tag.
 * @param {Options} [options]
 *   Configuration (optional).
 * @returns {string}
 *   Normal, canonical, and pretty BCP 47 tag.
 */
export function bcp47Normalize(tag: string, options?: Options | undefined): string;
export type Warning = import('bcp-47').Warning;
export type Schema = import('bcp-47').Schema;
export type Extension = import('bcp-47').Extension;
/**
 * Configuration (optional).
 */
export type Options = {
    /**
     * Passed to `bcp-47` as `options.forgiving`.
     */
    forgiving?: boolean;
    /**
     * Passed to `bcp-47` as `options.warning`.
     *
     * One additional warning is given:
     *
     * | code | reason                                                     |
     * | :--- | :--------------------------------------------------------- |
     * | 7    | Deprecated region `CURRENT`, expected one of `SUGGESTIONS` |
     *
     * This warning is only given if the region cannot be automatically fixed
     * (when regions split into multiple regions).
     */
    warning?: Warning;
};