# Zip

• 方法
  • compress 压缩生成Zip文件
  • decompress 解压缩Zip文件
  • compressImage 图片压缩转换

# compress

压缩生成Zip文件 (本地压缩)

• 参数说明

  参数名	类型	必填	说明
  src	String	是	要压缩文件或文件夹的真实路径
  zipfile	String	是	压缩完成产生的压缩文件路径，不传默认在当前src目录下
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 失败请查看全局状态码
  message	String	调用结果信息
  payload	String	回调结果,详见下表

• 返回payload参数说明

  参数名	类型	说明
  data	String	压缩后的文件路径

• 示例代码

let src = '/storage/emulated/0/Android/data/fox.app.ndemo/files/workspace/web-phone/debug/file/data';
let zipfile = '/storage/emulated/0/Android/data/fox.app.ndemo/files/data.zip';
foxsdk.zip.compress(src, zipfile, ret => {
    console.log('zip/compress===status: ' + ret.status + ',message: ' + ret.message +
        ',payload: ' + ret.payload);
});

# decompress

解压缩Zip文件 （本地解压）

• 参数说明

  参数名	类型	必填	说明
  target	String	是	解压完成生产的文件路径，不传默认在当前zipfile目录下,相对路径/绝对路径
  zipfile	String	是	要解压文件的真实路径,相对路径/绝对路径
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 失败请查看全局状态码
  message	String	调用结果信息
  payload	String	回调结果,详见下表

• 返回payload参数说明

  参数名	类型	说明
  data	String	解压成功的路径

• 示例代码

let target = '/storage/emulated/0/Android/data/fox.app.ndemo/files/workspace/web-phone/debug/file/data';
let zipfile = '/storage/emulated/0/Android/data/fox.app.ndemo/files/data.zip';
foxsdk.zip.decompress(zipfile, target, ret => {
    console.log('zip/decompress===status: ' + ret.status + ',message: ' + ret.message +
        ',payload: ' + ret.payload);
});

# compressImage

图片压缩转换 （支持 "jpg"、"png"）

• 参数说明

  参数名	类型	必填	说明
  options	Object	是	压缩图片参数配置
  completedCB	Function	可选	请求完成回调函数，成功/失败都会触发

• options参数说明

  参数名	类型	必填	说明
  src	String	是	压缩转换原始图片的绝对路径
  dst	String	是	压缩转换目标图片的绝对路径
  overwrite	Boolean	可选	覆盖生成新文件，仅在dst制定的路径文件存在时有效： true:覆盖,false:不覆盖(如果文件存在，则返回失败)。 默认:false
  quality	String	可选	压缩图片的质量，取值范围为1-100，默认:50
  width	String	可选	缩放图片的宽度，支持像素值（如"100px"）、百分比（如"50%"）、自动计算（如"auto"，即根据height与源图高的缩放比例计算，若未设置height则使用源图高度）； 默认:"auto
  height	String	可选	缩放图片的高度，支持像素值（如"100px"）、百分比（如"50%"）、自动计算（如"auto"，即根据width与源图宽的缩放比例计算，若未设置width则使用源图高度）； 默认:"auto"
  rotate	Number	可选	旋转图片的角度，支持值：90-表示旋转90度；180-表示旋转180度；270-表示旋转270度。
  clip	ClipImageOptions	可选	裁剪图片的区域，值参考ClipImageOptions定义，若设置clip属性值不合法，则不对图片进行裁剪操作
  outSize	String	可选	图片的指定大小，单位byte

• ClipImageOptions参数说明

  参数名	类型	必填	说明
  top	String	可选	图片裁剪区域与原图片上边界的偏移距离，支持像素值（如"10px"）、百分比（如"10%"）；默认值为"0px"。注意：如果top值加height值超出原图片高度，则使用"auto"值进行裁 （下几个参数相同）
  left	String	可选	图片裁剪区域与原图片左边界的偏移距离，支持像素值（如"10px"）、百分比（如"10%"）；默认值为"0px"。
  width	String	可选	图片裁剪区域的宽度，支持像素值（如"100px"）、百分比（如"50%"）、自动计算（如"auto"，即从left位置到图片右边界的宽度）；默认值为"auto"。
  height	String	可选	图片裁剪区域的高度，支持像素值（如"100px"）、百分比（如"50%"）、自动计算（如"auto"，即从top位置到图片下边界的高度）；默认值为"auto"

• completedCB返回参数说明

  参数名	类型	说明
  status	Number	调用状态码 0成功, 失败请查看全局状态码
  message	String	调用结果信息
  payload	String	回调结果,详见下表

• 返回payload参数说明

  参数名	类型	说明
  target	String	图片相对路径,"_www/thrial.png"
  size	String	图片压缩之后的大小
  width	String	图片压缩之后的宽
  height	String	图片压缩之后的高

• 示例代码

let options = {
    src: '/storage/emulated/0/DCIM/Camera/1582555025742.jpg',
    dst: '/storage/emulated/0/DCIM/Camera/22.zip',
    overwrite: false,
    format: 'png',
    quality: 20,
    width: '50%',
    height: '50%',
    rotate: 90
};
foxsdk.zip.compressImage(options, ret => {
    console.log('zip/compressImage===status: ' + ret.status + ',message: ' + ret.message + ',payload: ' +
        ret.payload);
});