Skip to content

Commit

Permalink
Merge pull request #30 from Chaphasilor/dev
Browse files Browse the repository at this point in the history
Introduce breaking change due to missing speedtest results
  • Loading branch information
Chaphasilor authored Aug 15, 2022
2 parents 5bc76cf + 0ca9246 commit e5cb6bf
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 4 deletions.
5 changes: 3 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ indexer.scanUrl(url)
| Wrapper Version | Supported ODD Versions (up to) | Included Version |
| --- | --- | --- |
| **8.0.3** | **v2.4.4.3+** | **v2.4.4.3** |
| **9.0.0** | **v2.4.4.3+** | **v2.4.4.3** |
| 8.0.2 | v2.4.4.3+** | v2.4.4.1 |
| 8.0.0 | v2.4.4.3+ | v2.3.1.4 |
| 7.0.0 | 2.2.0.1-2.2.0.2 | 2.2.0.2 |
Expand Down Expand Up @@ -115,7 +115,8 @@ Some intermediary releases might not be fully supported. It is recommended to us
- `keepJsonFile` (`Boolean`) (optional, default is `false`): Keep the JSON-file generated by the OpenDirectoryDownloader binary after the scan?
- `keepUrlFile` (`Boolean`) (optional, default is `false`): Keep the text-file generated by the OpenDirectoryDownloader binary after the scan?
- `parseScan` (`Boolean`) (optional, default is `false`): Parse the generated JSON file and include it in the `ScanResult`?
- `performSpeedtest` (`Boolean`) (optional, default is `false`): Perform a speed test after the scan is done? (usually takes a few seconds)
- `performSpeedtest` (`Boolean`) (optional, default is `false`): Perform a speed test after the scan is done? (usually takes a few seconds)
**Note:** For some OD formats, speed test are disabled by OpenDirectoryDownloader. For these, no test results will be included in `ScanResult.scan.SpeedtestResult`.
- `uploadUrlFile` (`Boolean`) (optional, default is `false`): Automatically upload the file containing all the found URLs to GoFile?
- `fastScan` (`Boolean`) (optional, default is `false`): Disable slow operations during the scan, like HEAD requests. This can result in file sizes being reported as "0" or "n/a", if the OD doesn't show file sizes next to the file names.
- `exactSizes` (`Boolean`) (optional, default is `false`) Use HEAD requests to retrieve exact file sizes
Expand Down
2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion package.json
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "open-directory-downloader",
"version": "8.0.3",
"version": "9.0.0",
"description": "A NodeJS wrapper around KoalaBear84/OpenDirectoryDownloader",
"main": "open-directory-downloader.js",
"scripts": {
Expand Down

0 comments on commit e5cb6bf

Please sign in to comment.