Feature/improvements #40
Conversation
ismi29ch
commented
Aug 3, 2023
•
ismi29ch
commented
- Added support for typescript
- Handle edge cases (error handling)
- Auto Pick name from Url
- User defined delay (Allow to pass custom delay)
|
Thanks for creating a TypeScript definition. 🙌 Can you follow this styleguide? Some examples: |
|
Hey @sindresorhus, |
|
Please rebase from the |
ismi29ch
force-pushed
the
feature/improvements
branch
from
8402fc2 to
3368761
Compare
|
Hey @sindresorhus, |
Custom delay Auto Pick name from Url Handle edge cases
ismi29ch
force-pushed
the
feature/improvements
branch
from
3cdff05 to
22bfef2
Compare
|
@sindresorhus |
| ##### downloadInterval | ||
|
|
||
| Type: `number` | ||
|
|
||
| The delay time between each file download in milliseconds. |
There was a problem hiding this comment.
This is the wrong location. Please look at the readme and you'll see that the below code example is for the rename option.
|
|
||
| await downloadFiles(); | ||
| ``` | ||
| */ |
There was a problem hiding this comment.
This file is messy code style wise. You are mixing spaces with tabs and the formatting is completely off.
Use the formatting shown in https://github.com/sindresorhus/typescript-definition-style-guide#documentation
Use single-quotes.
|
|
||
| @description - This function is used to determine the filename for each downloaded file. | ||
| */ | ||
| export type RenameFunction = (options: { |
There was a problem hiding this comment.
options is the wrong term here. They are not options.
|
|
||
| @param options - The options for downloading. | ||
|
|
||
| @returns - A promise that resolves when all files have been downloaded. |
There was a problem hiding this comment.
Use the correct TSDoc syntax. Applies to the everything else too.
| @returns - A promise that resolves when all files have been downloaded. | |
| @returns A promise that resolves when all files have been downloaded. |
| /** | ||
| @default undefined - (use original filenames) | ||
|
|
||
| @description - A function that returns the new filename for each downloaded file. |
There was a problem hiding this comment.
Missing example like in the readme.
