dreamworkAPI
Ctrl K
GitHub
typeDocs / gzip / Options

gzip.Options

typesharedmenusource

Options of gzip.compress, every field is optional.

gzip has no preset dictionaries, so dictionary is not allowed.

Fields

NameTypeDescription
level?integerThe compression level ( 0 - 9 ), 0 stores the data without compression, 1 is the fastest, 9 gives the smallest output, 6 by default.
strategy?"default" | "filtered" | "huffman_only" | "rle" | "fixed"The compression strategy, "default" by default, see deflate.Options.
name?stringThe original file name, without zero bytes.
comment?stringThe file comment, without zero bytes.
mtime?integerThe modification time of the original file as a Unix timestamp in seconds ( 0 - 4294967295 ), 0 (no time) by default.
os?integerThe operating system code ( 0 - 255 ) the file was compressed on, 3 is Unix, 11 is NTFS, by default the code of the runtime system ( 11 on Windows, 3 on Linux and macOS, 255 on others ).
extra?stringThe raw extra field (subfields of 2 ID bytes, 2 length bytes and data), up to 65535 bytes.
text?booleanMarks the data as probably ASCII text, false by default.
header_crc?booleanAdds the CRC-16 of the header, false by default.
Generated from the dreamwork meta branch.