Archiver object method · N/compress

archive()

Archiver.archive(options)

Creates an archive with the added files and returns it as a temporary file object.

Implementation
Not started
Design
Open for proposals suggest how it should read
Proposals
A
Signature
Archiver.archive(options)
Returns
file.File
Governance
25 units
Script types
Server scripts
Version
SuiteScript 2.x, documented for 2.1; since NetSuite 2020.2
call shapefrom Oracle's parameter table
1objArchiver.archive({2    name: /* string, required */,3    type: /* string, optional */4});
Oracle reference for this method
ParameterTypeRequiredDescription
options.namestringrequiredThe name of the archive file.
options.typestringoptionalThe archive type. See the compress.Type enum. This parameter does not need to be specified if options.name has one of the following extensions: .cpio .tar .tar.gz .tar.bz2 .tgz .tbz2 .zip
B

No Mynt syntax yet.

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

C

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

All discussions

Loading proposals from GitHub…

D

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/compress · Archiver.archive(options)

Suggest syntax for archive