chore: clean up Taxa TypeScript

johnkenny54 · Feb 10, 2025 · 25cde3c · 25cde3c
1 parent f03047e
commit 25cde3c
Show file tree

Hide file tree

Showing 2 changed files with 11 additions and 6 deletions.
diff --git a/lib/index.d.ts b/lib/index.d.ts
@@ -46,6 +46,10 @@ export type TaxonData = TaxonomyData & {
     taxon_name: string;
 };
 
+export type TaxonOverrides = {
+    status?: NativeStatusCode;
+};
+
 // Classes
 
 export class BasePageRenderer {
@@ -104,6 +108,7 @@ export class Files {
         targetFileName: string | undefined,
     ): Promise<Headers>;
     static mkdir(dir: string): void;
+    static read(path: string): string;
     static rmDir(dir: string): void;
     static write(fileName: string, data: string, overwrite?: boolean): void;
 }
@@ -188,11 +193,11 @@ export class Program {
 
 export class Taxa<T> {
     constructor(
-        inclusionList: Record<string, TaxonData> | true,
+        inclusionList: Record<string, TaxonOverrides> | true,
         errorLog: ErrorLog,
         showFlowerErrors: boolean,
         taxonFactory?: (td: TaxonData, g: Genera) => T,
-        extraTaxa?: TaxonData[],
+        extraTaxa?: TaxonOverrides[],
         extraSynonyms?: Record<string, string>[],
     );
     getTaxon(name: string): T;

diff --git a/lib/taxonomy/taxa.js b/lib/taxonomy/taxa.js
@@ -40,7 +40,7 @@ class Taxa {
     #isSubset;
 
     /**
-     * @param {Object<string,import("../index.js").TaxonData>|true} inclusionList
+     * @param {Object<string,import("../index.js").TaxonOverrides>|true} inclusionList
      * @param {ErrorLog} errorLog
      * @param {boolean} showFlowerErrors
      * @param {function(import("../index.js").TaxonData,Genera):Taxon} taxonFactory
@@ -224,7 +224,7 @@ class Taxa {
 
     /**
      * @param {SynonymData[]} synCSV
-     * @param {Object<string,import("../index.js").TaxonData>|boolean} inclusionList
+     * @param {Object<string,import("../index.js").TaxonOverrides>|boolean} inclusionList
      */
     #loadSyns(synCSV, inclusionList) {
         for (const syn of synCSV) {
@@ -246,7 +246,7 @@ class Taxa {
 
     /**
      * @param {import("../index.js").TaxonData[]} taxaCSV
-     * @param {Object<string,import("../index.js").TaxonData>|true} inclusionList
+     * @param {Object<string,import("../index.js").TaxonOverrides>|true} inclusionList
      * @param {function(import("../index.js").TaxonData,Genera):Taxon} taxonFactory
      * @param {Genera} genera
      * @param {boolean} showFlowerErrors
@@ -255,7 +255,7 @@ class Taxa {
         for (const row of taxaCSV) {
             const name = row["taxon_name"];
 
-            /** @type {import("../index.js").TaxonData|{status?:import("../index.js").NativeStatusCode}} */
+            /** @type {import("../index.js").TaxonOverrides} */
             let taxon_overrides = {};
             if (inclusionList !== true) {
                 taxon_overrides = inclusionList[name];