http.download

Downloads an HTTP resource from the specified URL to a file.

http.download(url, file, { options })

Parameters

url is the URL to be downloaded.

file is the destination file that will be written to.

options is a table of options used for this http retrieval

• progress is a Lua callback function that receives two numeric arguments representing total and current download progress in bytes.
• headers is a Lua table with HTTP headers to be used on the request.
• userpwd is a username and optional password in the format of username:password which will be used to authenticate the request
• username is the username which will be used to authenticate the request
• password is the password which will be used to authenticate the request

Return Value

True if successful, otherwise nil and an error message.

Examples

local result, error = http.download("http://example.com/file.zip", "file.zip")

function progress(total, current)
  local ratio = current / total;
  ratio = math.min(math.max(ratio, 0), 1);
  local percent = math.floor(ratio * 100);
  print("Download progress (" .. percent .. "%/100%)")
end

local result, error = http.download("http://example.com/file.zip", "file.zip" {
    progress = progress,
    headers = { "From: Premake", "Referer: Premake" }, 
    userpwd = "username:password"
})

Backward compatible function signature

The previous signature of this function was

http.download(url, file, progress, headers)

and continues to be supported. This is equivalent to

http.download(url, file, { progress = progress, headers = headers })

Availability

Premake 5.0 or later.

See Also

• http.get