mynt

Connection object method · N/sftp

download()

Connection.download(options)

Downloads a file from the remote FTP server.

Implementation
Not started
Design
Open for proposals suggest how it should read
Proposals
A suitescript api
Signature
Connection.download(options)
Module
N/sftp
Returns
file.File
Governance
100 units
Script types
Server scripts
Version
SuiteScript 2.x, documented for 2.1; since NetSuite 2016.2
call shapefrom Oracle's parameter table
1objConnection.download({2    filename:  /* string, required */,3    directory: /* string, optional */,4    timeout:   /* number, optional */5});
Oracle reference for this method
ParameterTypeRequiredDescription
options.filenamestringrequiredThe name of the file to download.
options.directorystringoptionalThe relative path to the directory that contains the file to download. By default, the path is set to the current directory. Important: This input must take the form of a relative path.
options.timeoutnumberoptionalThe number of seconds to allow for the file to download. By default, this value is set to 300 seconds.
B mynt syntax

No Mynt syntax yet.

Nothing in the language compiles to Connection.download(options) today. How should it read?

C community proposals

Competing syntax for download, from GitHub Discussions. Select two or more to compare them side by side.

All discussions

Loading proposals from GitHub…

D suggest an alternative

Write the Mynt you wish you could write.

A good proposal shows the syntax, the SuiteScript it should become, and argues for it: why it is clearer, how it fits the rest of the language, what it makes harder.

  • Clarity. Does it say what happens, without ceremony?
  • Consistency. Does it read like load, save and Ref[field]?
  • Expressiveness. Does it cover the cases people actually write?
  • Honesty. Does it hide a NetSuite cost, such as governance, that a reader should see?

N/sftp · Connection.download(options)

Suggest syntax for download