Skip to content

Commit

Permalink
fix(README): explain close and delete
Browse files Browse the repository at this point in the history
  • Loading branch information
ido-pluto committed Apr 8, 2024
1 parent 2846351 commit 7a6f238
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,9 @@ await downloader.download();

### Abort download

You can cancel the download by calling the `abort` method
You can cancel the download by calling the `close` method (it will not delete the file).

If you want to also delete the file, you can call the `closeAndDeleteFile` method.

```ts
import {downloadFile} from 'ipull';
Expand Down

0 comments on commit 7a6f238

Please sign in to comment.