Merge pull request #149 from charlesLoder/is-in-construct

Is in construct

src/word.ts

@@ -221,4 +221,15 @@ export class Word {
   get isNotHebrew(): boolean {
     return !this.clusters.map((c) => c.isNotHebrew).includes(false);
   }
+
+  /**
+   * Returns `true` if the Word is in a construct state
+   *
+   * @description
+   * The construct state is indicated by the presence of a maqqef (U+05BE) character
+   */
+  get isInConstruct(): boolean {
+    // if word has a maqqef, it is in construct
+    return this.text.includes("\u05BE");
+  }
 }

test/word.test.ts

@@ -50,3 +50,14 @@ describe.each`
     });
   });
 });
+
+describe.each`
+  description      | heb              | isInConstructArray
+  ${"with maqqef"} | ${"בֶּן־אָדָ֕ם"} | ${[true, false]}
+  ${"now maqqef"}  | ${"בֶּן אָדָ֕ם"} | ${[false, false]}
+`("isInConstruct:", ({ description, heb, isInConstructArray }) => {
+  const text = new Text(heb);
+  test(`${description}`, () => {
+    expect(text.words.map((word) => word.isInConstruct)).toEqual(isInConstructArray);
+  });
+});