chore(moduleExec): more inline docs: executive summary at top (#13)

gadicc · Feb 5, 2021 · 0d619f7 · 0d619f7
1 parent c63675b
commit 0d619f7
Showing 1 changed file with 17 additions and 0 deletions.
diff --git a/src/lib/moduleExec.ts b/src/lib/moduleExec.ts
@@ -1,3 +1,20 @@
+/*
+ * moduleExec(options: ModuleExecOptions)
+ *
+ * 1. Query Stage
+ *   1. Validate user-supplied module params, e.g. { period: '1d' }
+ *   2. Merge query params: (module defaults, user-supplied overrides, etc)
+ *   3. Optionally transform query params
+ *
+ * 2. Call lib/yahooFinanceFetch
+ *
+ * 3. Result Stage
+ *   1. Optional transform the result
+ *   2. Validate the result and coerce types
+ *
+ * Further info below, inline.
+ */
+
 import validateAndCoerceTypes from './validateAndCoerceTypes';
 import csv2json from './csv2json';