summaryrefslogtreecommitdiff
path: root/node_modules/bcp-47-normalize/lib/index.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'node_modules/bcp-47-normalize/lib/index.d.ts')
-rw-r--r--node_modules/bcp-47-normalize/lib/index.d.ts36
1 files changed, 36 insertions, 0 deletions
diff --git a/node_modules/bcp-47-normalize/lib/index.d.ts b/node_modules/bcp-47-normalize/lib/index.d.ts
new file mode 100644
index 0000000..c1b935f
--- /dev/null
+++ b/node_modules/bcp-47-normalize/lib/index.d.ts
@@ -0,0 +1,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;
+};