adm-zip-0.4.13-中文文檔詳解

更新時(shí)間：2023年05月30日 10:02:37 作者：囧

這篇文章主要介紹了adm-zip-0.4.13-中文文檔,本文給大家介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或工作具有一定的參考借鑒價(jià)值，需要的朋友可以參考下

adm-zip-0.4.13-中文文檔

adm-zip.js
- constructor(filePath)
- getEntries()
- getEntry(name)
- readFile(entry)
- readFileAsync(entry, callback)
- readAsText(entry, encoding)
- readAsTextAsync(entry, callback, encoding)
- deleteFile(entry)
- addZipComment(comment)
- getZipComment( )
- addZipEntryComment(entry, comment)
- getZipEntryComment(entry)
- updateFile(entry, content)
- addLocalFile(localPath, zipPath)
- addLocalFolder(localPath, zipPath)
- addFile(entryName, content, comment, attr)
- extractEntryTo(entry, targetPath, maintainEntryPath, overwrite)
- extractAllTo(targetPath, overwrite)
- writeZip(targetFileName)
- toBuffer(onSuccess, onFail, onItemStart,onItemEnd)

adm-zip

// 引入adm-zip
var admZip = require('adm-zip');
console.log(admZip);

constructor(filePath)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的test.zip文件
var localZip = new admZip('d:/test.zip');
console.log(localZip);
// 在內(nèi)存中創(chuàng)建新的zip文件
var newZip = new admZip();
console.log(newZip);

getEntries()

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取所有zip中entry并遍歷
zip.getEntries().forEach(function(entry){
	var entryName = entry.entryName;
	console.log(entryName);
	var decompressedData = zip.readFile(entry);
	console.log(decompressedData);
	console.log(zip.readAsText(entry));   
});

getEntry(name)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取d:/test.zip中的test.js這個(gè)entry
var entry = zip.getEntry('test.js');
console.log(entry);

readFile(entry)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取d:/test.zip中的test.js這個(gè)entry
var entry = zip.getEntry('test.js');
// 獲取entry對(duì)應(yīng)的buffer
var buffer = zip.readFile(entry);
console.log(buffer);

readFileAsync(entry, callback)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取d:/test.zip中的test.js這個(gè)entry
var entry = zip.getEntry('test.js');
// 獲取entry對(duì)應(yīng)的buffer
zip.readFileAsync(entry, function(buffer, err){
	console.log(buffer, err);
});

readAsText(entry, encoding)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取d:/test.zip中的test.js這個(gè)entry
var entry = zip.getEntry('test.js');
// 獲取entry對(duì)應(yīng)的text
var data = zip.readAsText(entry, 'utf8');
console.log(data);

readAsTextAsync(entry, callback, encoding)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取d:/test.zip中的test.js這個(gè)entry
var entry = zip.getEntry('test.js');
// 獲取entry對(duì)應(yīng)的text
zip.readAsTextAsync(entry, function(data, err){
	console.log(data, err);
}, 'utf8');

deleteFile(entry)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取d:/test.zip中的test.js這個(gè)entry
var entry = zip.getEntry('test.js');
// 刪除entry
zip.deleteFile(entry);
// 刪除entry后必須重寫(xiě)zip一次
zip.writeZip('d:/test.zip');

addZipComment(comment)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 為zip添加comment
zip.addZipComment('test');
// 添加comment后必須重寫(xiě)zip文件
zip.writeZip('d:/test.zip');

getZipComment()

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取zip的comment
var comment = zip.getZipComment();
console.log(comment);

addZipEntryComment(entry, comment)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取d:/test.zip中的test.js這個(gè)entry
var entry = zip.getEntry('test.js');
// 為zip中的test.js這個(gè)entry添加comment
zip.addZipEntryComment(entry, 'test');
// 添加comment后必須重寫(xiě)zip文件
zip.writeZip('d:/test.zip');

getZipEntryComment(entry)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取d:/test.zip中的test.js這個(gè)entry
var entry = zip.getEntry('test.js');
// 獲取zip中的test.js這個(gè)entry的comment
var comment = zip.getZipEntryComment(entry);
console.log(comment);

updateFile(entry, content)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取d:/test.zip中的test.js這個(gè)entry
var entry = zip.getEntry('test.js');
// 為zip中的test.js這個(gè)entry更新內(nèi)容為文字'test'
zip.updateFile(entry, 'test');
// update file后必須重寫(xiě)zip文件
zip.writeZip('d:/test.zip');

addLocalFile(localPath, zipPath)

// 引入adm-zip
var admZip = require('adm-zip');
// 在內(nèi)存中創(chuàng)建新的zip文件
var zip = new admZip(); 
// 為zip添加本地文件
zip.addLocalFile('d:/test.js');
// 生成zip文件
zip.writeZip('d:/test.zip');

addLocalFolder(localPath, zipPath)

// 引入adm-zip
var admZip = require('adm-zip');
// 在內(nèi)存中創(chuàng)建新的zip文件
var zip = new admZip(); 
// 為zip添加本地文件夾
zip.addLocalFolder('d:/test');
// 生成zip文件
zip.writeZip('d:/test.zip');

addFile(entryName, content, comment, attr)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 為zip添加文件，文件名為entry.js，內(nèi)容為content，備注為comment
zip.addFile('entry.js', 'content', 'comment', null);
// 生成zip文件
zip.writeZip('d:/test.zip');

extractEntryTo(entry, targetPath, maintainEntryPath, overwrite)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 獲取d:/test.zip中的entry.js這個(gè)entry
var entry = zip.getEntry('entry.js');
// 將test.js這個(gè)entry解壓縮到d:/
// 第一個(gè)true，如果有父文件夾則創(chuàng)建父文件夾
// 第二個(gè)true，是否覆蓋
zip.extractEntryTo(entry, 'd:/', true, true);

extractAllTo(targetPath, overwrite)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 將d:/test.zip這個(gè)zip文件解壓縮到d:/test11文件夾下
// 第一個(gè)true，是否覆蓋
zip.extractAllTo('d:/test11', true);

writeZip(targetFileName, callback)

// 引入adm-zip
var admZip = require('adm-zip');
// 加載并解析存在的d:/test.zip文件
var zip = new admZip('d:/test.zip'); 
// 操作zip，例如刪除entry，更新file等
// handle zip
// 寫(xiě)入到d:/test.zip中，也可以是其他path
zip.writeZip('d:/test.zip', function(err, msg){
	console.log(err, msg);
});
// 如果只傳callback，就會(huì)寫(xiě)入到打開(kāi)的zip文件中
zip.writeZip(function(err, msg){
	console.log(err, msg);
});

到此這篇關(guān)于adm-zip-0.4.13-中文文檔的文章就介紹到這了,更多相關(guān)adm-zip-0.4.13-中文文檔內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！