Skip to content

Commit 11d1ca2

Browse files
Merge pull request #319 from dixyushi/update-downloadFile
Update downloadFile content
2 parents 9b9c874 + 3c42afb commit 11d1ca2

1 file changed

Lines changed: 16 additions & 3 deletions

File tree

documentation/Functions.md

Lines changed: 16 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -449,13 +449,26 @@ Note:
449449
***
450450

451451
### downloadFile <a name="downloadFile"></a>
452+
This function is used to download a file from an external URL.
452453
#### parameter
453-
1. URL of the file to be downloaded.
454-
2. Name of file.
455-
3. (Optional) Downloads file to a given directory relative to workspace. Directory is created, if its not existing.
454+
This function consist of 3 parameters.
455+
1. First parameter:
456+
- **Required**
457+
- **Type**- String
458+
- **Description**- URL of the file to be downloaded.
459+
2. Second Parameter:
460+
- **Required**
461+
- **Type**- String
462+
- **Description**- Name of file
463+
3. Third parameter:
464+
- **Optional**
465+
- **Type**- String
466+
- **Description**- The path where the file should be stored. It can be used if you want to load the file into a different folder and not into the current Workspace. If folder does not exists, it will be created.
456467
#### example
457468
downloadFile("https://bit.ly/2BCkFa9", "file", "downloads")
458469

470+
Note: The command for execution will be generated by Katacoda runner, so user will have to execute this command manually.
471+
459472
***
460473

461474
### buildNg <a name="buildNg"></a>

0 commit comments

Comments
 (0)