fix(crumb): needsCrumb option, and in quote() only

gadicc · May 7, 2023 · cf92258 · cf92258
1 parent c21f025
commit cf92258
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 5 deletions.
diff --git a/src/lib/moduleExec.ts b/src/lib/moduleExec.ts
@@ -74,6 +74,10 @@ interface ModuleExecOptions {
      * Default: 'json'.  Can be 'text' or 'csv' (augments fetch's "text").
      */
     fetchType?: string;
+    /**
+     * Default: false.  This request requires Yahoo cookies & crumb.
+     */
+    needsCrumb: boolean;
   };
 
   result: {
@@ -145,7 +149,8 @@ async function moduleExec(this: ThisWithModExec, opts: ModuleExecOptions) {
     queryOpts.url,
     queryOptions,
     moduleOpts,
-    queryOpts.fetchType
+    queryOpts.fetchType,
+    queryOpts.needsCrumb
   );
 
   if (queryOpts.fetchType === "csv") result = csv2json(result);

diff --git a/src/lib/yahooFinanceFetch.ts b/src/lib/yahooFinanceFetch.ts
@@ -64,7 +64,8 @@ async function yahooFinanceFetch(
   urlBase: string,
   params = {},
   moduleOpts: YahooFinanceFetchModuleOptions = {},
-  func = "json"
+  func = "json",
+  needsCrumb = false
 ) {
   if (!(this && this._env))
     throw new errors.NoEnvironmentError(
@@ -91,8 +92,10 @@ async function yahooFinanceFetch(
     },
   };
 
-  // @ts-expect-error: TODO, crumb string type for partial params
-  params.crumb = await getCrumb(fetchFunc, fetchOptionsBase);
+  if (needsCrumb) {
+    // @ts-expect-error: TODO, crumb string type for partial params
+    params.crumb = await getCrumb(fetchFunc, fetchOptionsBase);
+  }
 
   // @ts-expect-error: TODO copy interface? @types lib?
   const urlSearchParams = new URLSearchParams(params);

diff --git a/src/modules/quote.ts b/src/modules/quote.ts
@@ -262,8 +262,8 @@ export default async function quote(
 
     query: {
       url: "https://${YF_QUERY_HOST}/v7/finance/quote",
-      schemaKey: "#/definitions/QuoteOptions",
       needsCrumb: true,
+      schemaKey: "#/definitions/QuoteOptions",
       defaults: queryOptionsDefaults,
       runtime: { symbols },
       overrides: queryOptionsOverrides,