@ohos.zlib (Zip)

The Zip module provides APIs for file compression and decompression.

NOTE

The initial APIs of this module are supported since API version 7. Newly added APIs will be marked with a superscript to indicate their earliest API version.

Modules to Import

import zlib from '@ohos.zlib';

zlib.zipFile^(deprecated)

zipFile(inFile: string, outFile: string, options: Options): Promise<void>

Zips a file. This API uses a promise to return the result.

This API is deprecated since API version 9. You are advised to use zlib.compressFile instead.

System capability: SystemCapability.BundleManager.Zlib

Parameters

Return value

Example 1

// Zip a file.
// The path used in the code must be an application sandbox path, for example, /data/storage/el2/base/haps. You can obtain the path through the context.
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';

let inFile = '/xxx/filename.xxx';
let outFile = '/xxx/xxx.zip';
let options: zlib.Options = {
  level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
  memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
  strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};

zlib.zipFile(inFile, outFile, options).then((data: void) => {
    console.log('zipFile result is ' + JSON.stringify(data));
}).catch((err: BusinessError) => {
    console.log('error is ' + JSON.stringify(err));
});

Example 2

// Zip a folder.
// The path used in the code must be an application sandbox path, for example, /data/storage/el2/base/haps. You can obtain the path through the context.
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';

let inFile = '/xxx/xxx';
let outFile = '/xxx/xxx.zip';
let options: zlib.Options = {
  level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
  memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
  strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};

zlib.zipFile(inFile , outFile, options).then((data: void) => {
    console.log('zipFile result is ' + JSON.stringify(data));
}).catch((err: BusinessError)=>{
    console.log('error is ' + JSON.stringify(err));
});

zlib.unzipFile^(deprecated)

unzipFile(inFile:string, outFile:string, options: Options): Promise<void>

Unzips a file. This API uses a promise to return the result.

This API is deprecated since API version 9. You are advised to use zlib.decompressFile instead.

System capability: SystemCapability.BundleManager.Zlib

Parameters

Return value

Example

// Unzip a file.
// The path used in the code must be an application sandbox path, for example, /data/storage/el2/base/haps. You can obtain the path through the context.
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';

let inFile = '/xx/xxx.zip';
let outFile = '/xxx';

let options: zlib.Options = {
  level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
  memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
  strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};
zlib.unzipFile(inFile, outFile, options).then((data: void) => {
    console.log('unzipFile result is ' + JSON.stringify(data));
}).catch((err: BusinessError)=>{
    console.log('error is ' + JSON.stringify(err));
})

zlib.compressFile⁹⁺

compressFile(inFile: string, outFile: string, options: Options, callback: AsyncCallback<void>): void;

Compresses a file. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BundleManager.Zlib

Parameters

Error codes

For details about the error codes, see zlib Error Codes.

Example

// Compress a file.
// The path used in the code must be an application sandbox path, for example, /data/storage/el2/base/haps. You can obtain the path through the context.
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';

let inFile = '/xxx/filename.xxx';
let outFile = '/xxx/xxx.zip';
let options: zlib.Options = {
  level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
  memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
  strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};

try {
    zlib.compressFile(inFile, outFile, options, (errData: BusinessError) => {
        if (errData !== null) {
            console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
        }
    })
} catch(errData) {
    let code = (errData as BusinessError).code;
    let message = (errData as BusinessError).message;
    console.log(`errData is errCode:${code}  message:${message}`);
}

zlib.compressFile⁹⁺

compressFile(inFile: string, outFile: string, options: Options): Promise<void>;

Compresses a file. This API uses a promise to return the result.

System capability: SystemCapability.BundleManager.Zlib

Parameters

Error codes

For details about the error codes, see zlib Error Codes.

// Compress a file.
// The path used in the code must be an application sandbox path, for example, /data/storage/el2/base/haps. You can obtain the path through the context.
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';

let inFile = '/xxx/filename.xxx';
let outFile = '/xxx/xxx.zip';
let options: zlib.Options = {
  level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION,
  memLevel: zlib.MemLevel.MEM_LEVEL_DEFAULT,
  strategy: zlib.CompressStrategy.COMPRESS_STRATEGY_DEFAULT_STRATEGY
};

try {
    zlib.compressFile(inFile, outFile, options).then((data: void) => {
        console.info('compressFile success');
    }).catch((errData: BusinessError) => {
        console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
    })
} catch(errData) {
    let code = (errData as BusinessError).code;
    let message = (errData as BusinessError).message;
    console.log(`errData is errCode:${code}  message:${message}`);
}

zlib.decompressFile⁹⁺

decompressFile(inFile: string, outFile: string, options: Options, callback: AsyncCallback<void>): void;

Decompresses a file. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BundleManager.Zlib

Parameters

Error codes

For details about the error codes, see zlib Error Codes.

Example

// Decompress a file.
// The path used in the code must be an application sandbox path, for example, /data/storage/el2/base/haps. You can obtain the path through the context.
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';

let inFile = '/xx/xxx.zip';
let outFileDir = '/xxx';
let options: zlib.Options = {
  level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION
};

try {
    zlib.decompressFile(inFile, outFileDir, options, (errData: BusinessError) => {
        if (errData !== null) {
            console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
        }
    })
} catch(errData) {
    let code = (errData as BusinessError).code;
    let message = (errData as BusinessError).message;
    console.log(`errData is errCode:${code}  message:${message}`);
}

zlib.decompressFile⁹⁺

decompressFile(inFile: string, outFile: string, options?: Options): Promise<void>;

Decompresses a file. This API uses a promise to return the result.

System capability: SystemCapability.BundleManager.Zlib

Parameters

Error codes

For details about the error codes, see zlib Error Codes.

// Decompress a file.
// The path used in the code must be an application sandbox path, for example, /data/storage/el2/base/haps. You can obtain the path through the context.
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';

let inFile = '/xx/xxx.zip';
let outFileDir = '/xxx';
let options: zlib.Options = {
  level: zlib.CompressLevel.COMPRESS_LEVEL_DEFAULT_COMPRESSION
};

try {
    zlib.decompressFile(inFile, outFileDir, options).then((data: void) => {
        console.info('decompressFile success');
    }).catch((errData: BusinessError) => {
        console.log(`errData is errCode:${errData.code}  message:${errData.message}`);
    })
} catch(errData) {
    let code = (errData as BusinessError).code;
    let message = (errData as BusinessError).message;
    console.log(`errData is errCode:${code}  message:${message}`);
}

zlib.decompressFile¹⁰⁺

decompressFile(inFile: string, outFile: string, callback: AsyncCallback<void>): void;

Decompresses a file. This API uses an asynchronous callback to return the result.

System capability: SystemCapability.BundleManager.Zlib

Parameters

Error codes

For details about the error codes, see zlib Error Codes.

Example

// Unzip a file.
// The path used in the code must be an application sandbox path, for example, /data/storage/el2/base/haps. You can obtain the path through the context.
import zlib from '@ohos.zlib';
import { BusinessError } from '@ohos.base';
let inFile = '/xx/xxx.zip';
let outFileDir = '/xxx';

try {
    zlib.decompressFile(inFile, outFileDir, (errData: BusinessError) => {
        if (errData !== null) {
            console.log(`decompressFile failed. code is ${errData.code}, message is ${errData.message}`);
        }
    })
} catch(errData) {
    let code = (errData as BusinessError).code;
    let message = (errData as BusinessError).message;
    console.log(`decompressFile failed. code is ${code}, message is ${message}`);
}

Options

System capability: SystemCapability.BundleManager.Zlib

zip.CompressLevel

System capability: SystemCapability.BundleManager.Zlib

zip.MemLevel

System capability: SystemCapability.BundleManager.Zlib

zip.CompressStrategy

System capability: SystemCapability.BundleManager.Zlib

zip.ErrorCode

System capability: SystemCapability.BundleManager.Zlib

你可能感兴趣的鸿蒙文章

harmony 鸿蒙APIs

harmony 鸿蒙System Common Events (To Be Deprecated Soon)

harmony 鸿蒙System Common Events

harmony 鸿蒙API Reference Document Description

harmony 鸿蒙Enterprise Device Management Overview (for System Applications Only)

harmony 鸿蒙BundleStatusCallback

harmony 鸿蒙@ohos.bundle.innerBundleManager (innerBundleManager)

harmony 鸿蒙@ohos.distributedBundle (Distributed Bundle Management)

harmony 鸿蒙@ohos.bundle (Bundle)

harmony 鸿蒙@ohos.enterprise.EnterpriseAdminExtensionAbility (EnterpriseAdminExtensionAbility)