🤖 Merge PR DefinitelyTyped#74487 Feature/add hyphen exceptions param by @jono-pov

Author: jono-pov

types/hyphen/hyphen-tests.ts

@@ -39,3 +39,11 @@ if (hyphenateEnUsSyncWithMinWordLength("sabotaging") !== "sabotaging") {
     // sabotaging has 10 chars => don't hyphenate
     throw new Error("Test failed");
 }
+
+// Test with exceptions
+const hyphenateWithExceptions = createHyphenator(hyphenationPatternsEnGb, {
+    exceptions: ["Bland-thorn"],
+}) as HyphenationFunctionSync;
+if (hyphenateWithExceptions("Blandthorn") !== "Bland-thorn") {
+    throw new Error("Test failed");
+}

types/hyphen/index.d.ts

@@ -43,6 +43,13 @@ declare namespace hyphen {
          * @default 5
          */
         minWordLength?: number | undefined;
+
+        /**
+         * An array of values with exceptions of hyphenation in words.
+         * Hard hyphen symbol `-` should be used to mark the position of further configured hyphenation symbol.
+         * @default []
+         */
+        exceptions?: string[] | undefined;
     }
 
     /**
@@ -66,6 +73,13 @@ declare namespace hyphen {
          * @default 5
          */
         minWordLength?: number | undefined;
+
+        /**
+         * An array of values with exceptions of hyphenation in words.
+         * Hard hyphen symbol `-` should be used to mark the position of further configured hyphenation symbol.
+         * @default []
+         */
+        exceptions?: string[] | undefined;
     }
 
     /**

types/hyphen/package.json

@@ -1,7 +1,7 @@
 {
     "private": true,
     "name": "@types/hyphen",
-    "version": "1.6.9999",
+    "version": "1.14.9999",
     "projects": [
         "https://github.com/ytiurin/hyphen"
     ],