Add logDirectory to types

harvard-lil · Aug 16, 2024 · 6b8c919 · 6b8c919
1 parent ba6644e
commit 6b8c919
Showing 1 changed file with 1 addition and 0 deletions.
diff --git a/types.js b/types.js
@@ -14,6 +14,7 @@
  * @property {?Object} datapackageExtras - If set, will be appended to datapackage.json under `extras`.
  * @property {?string} cdxj - If set, skips indexing and allows for passing CDXJ files "as is". Path to a folder containing CDXJ files.
  * @property {?string} pages - If set, allows for passing pre-set pages.jsonl file(s). Path to a folder containing pages files (pages.jsonl, extraPages.jsonl ...). Must be used in combination with `pages`, since using this option will skip the step required to generate a pages.jsonl file.
+ * @property {?string} logDirectory - If set, allows for passing existing crawler log files into the WACZ. Path to a folder containing log files. Only files with log or txt extensions in that folder will be copied.
  * @property {?any} log - Will be used instead of the Console API for logging, if compatible (i.e: loglevel). Defaults to globalThis.console.
  */