jdoc, changed variable to function for documentation purposes

duart38 · Mar 16, 2021 · 01f3555 · 01f3555
1 parent 80ae85f
commit 01f3555
Show file tree

Hide file tree

Showing 2 changed files with 12 additions and 1 deletion.
diff --git a/builder/ARRAY.ts b/builder/ARRAY.ts
@@ -119,6 +119,12 @@ export class ARR<I> implements WritableBuilder<Array<I>, ARR<I>>, Logical {
     return this;
   }
 }
+
+/**
+ * Helper method to initiate an ARRAY carpenter
+ * @param value 
+ * @returns 
+ */
 export function ARRAY<I>(val: I[]): ARR<I> {
   return new ARR(val);
 }
diff --git a/builder/STRING.ts b/builder/STRING.ts
@@ -148,4 +148,9 @@ export class STR implements WritableBuilder<string, STR>, Logical {
     return this;
   }
 }
-export const STRING = (value: string) => new STR(value);
+/**
+ * Helper method to initiate a STRING carpenter
+ * @param value 
+ * @returns 
+ */
+export function STRING(value: string){return new STR(value)}