github-extractor / GithubExtractor / DownloadToOptions

DownloadToOptions

Properties

dest

dest: string;

Destination to download the files into. Warning: it will overwrite any existing files by default unless extractOptions are set.

---

extractOptions?

optional extractOptions: Omit<ExtractOptions, "filter" | "cwd" | "onentry" | "C">;

Pass through options for the tar.extract stream. Not very important but here for completeness.

---

match?

optional match: RegExp;

Must match every regular expression if given. If selectedPaths is given, it will operate on selected only.

---

onFileWritten()?

optional onFileWritten: (entry) => void;

Callback for when a file is written. Useful for logging or other operations.

Parameters

• entry: ReadEntry

Returns

void

---

selectedPaths?

optional selectedPaths: string[];

Will only download these paths.

Example

["README.md", ".github/workflows/ci.yml"]