External module "commands/gzip"

Const gzip

• gzip(source: string, filename?: string, destination?: string, password?: string): Promise<Object | void>

• Compress a local file.

  Parameters

  • source: string

    The source file to be compressed

  • Default value filename: string = "file"

    The name of the compressed file. Defaults to "file.extension"

  • Default value destination: string = __dirname

    Where to store the compressed file. Defaults to the current directory

  • Optional password: string

    Optional password to encrypt the compressed file

  Returns Promise<Object | void>

  Either resolves with an object containing fullFilename and destination of the compressed file or rejects with an error