オブジェクトジップファイル
ZipFile オブジェクトはzipフォーマット ファイルの圧縮および解凍モジュールの重要なオブジェクト。zipファイルへの読み取りおよび書き込みアクセス
ZipFile オブジェクトはから継承しますStreamオブジェクトなので渡すことができますStreamオブジェクトと同じように操作します。
一般的に使用される静的関数は次のとおりです。
- zip.open:開くzipファイルまたはストリーム
- zip.isZipFile: ファイルがzip書類
- fs.setZipFS:設定zipファイル仮想ファイルシステム
- fs.clearZipFS: クリアzipファイル仮想ファイルシステム
ZipFile オブジェクトの一般的なインスタンス関数とメソッドは次のとおりです。
- NArrayZipFile.namelist(): ファイル名のリストを取得します。
- NオブジェクトZipFile.getinfo(文字列メンバー): ファイル情報を取得します
- Buffer ZipFile.read(文字列メンバー、文字列パスワード = ""): 指定されたファイルを読み取ります
- NArrayZipFile.readAll(文字列パスワード = ""): すべてのファイルを読み取ります
- 空所ZipFile.extract(文字列メンバー、文字列path、文字列パスワード = ""): 指定したパスにファイルを解凍します。
- 空所ZipFile.extract(ストリングメンバー、SeekableStreamstrm、文字列パスワード = ""): ファイルをストリームに解凍します。
- 空所ZipFile.extractAll(弦path、文字列パスワード = ""): すべてのファイルを指定されたパスに抽出します。
- 空所ZipFile.write(文字列ファイル名、文字列inZipName、文字列パスワード = ""): 指定されたファイルを圧縮ファイルに書き込みます
- 空所ZipFile.write(Bufferデータ、文字列 inZipName、文字列パスワード = ""): 指定されたファイルを圧縮ファイルに書き込みます
- 空所ZipFile.write(SeekableStreamstrm, String inZipName, String passwd = ""): 指定されたファイルを圧縮ファイルに書き込みます
- 空所ZipFile.close(): 閉じて開くzip書類
コード例は次のとおりです。
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15var zip = require('zip');
var path = require('path');
var fs = require('fs');
var zipfile = zip.open(path.join(__dirname, 'unzip_test.zip'), 'w');
// write a file
var buf = new Buffer('test data');
zipfile.write(buf, 'test.txt');
// read a file
buf = zipfile.read("unzip_test.js");
console.log(buf);
zipfile.close();
相続関係
メンバー関数
namelist
ファイル名のリストを取得する
1NArray ZipFile.namelist() async;
返される結果:
- NArray、ファイル名を含むリストオブジェクトを返します。
infolist
ファイル情報一覧の取得
1NArray ZipFile.infolist() async;
返される結果:
- NArray、ファイル情報を含むリストオブジェクトを返します。
ファイル情報には、ファイル名、日付、圧縮タイプ、圧縮サイズ、ファイルサイズ、パスワード、データのフィールドが含まれます。
getinfo
ファイル情報を取得する
1NObject ZipFile.getinfo(String member) async;
呼び出しパラメータ:
- member: 文字列。情報を取得するファイル名を指定します。
返される結果:
- NObject、ファイル情報オブジェクトを返します。
ファイル情報には、ファイル名、日付、圧縮タイプ、圧縮サイズ、ファイルサイズ、パスワード、データのフィールドが含まれます。
read
圧縮ファイルから読み取ったデータを返します
1
2Buffer ZipFile.read(String member,
String password = "") async;
呼び出しパラメータ:
- member: 文字列、読み込むファイル名を指定します
- password: 文字列、解凍パスワード、デフォルトではパスワードなし
返される結果:
- Buffer、ファイルのすべてのデータを返します
readAll
すべてのファイルを解凍します
1NArray ZipFile.readAll(String password = "") async;
呼び出しパラメータ:
- password: 文字列、解凍パスワード、デフォルトではパスワードなし
返される結果:
- NArray、すべてのファイルのデータと情報を含むリスト
extract
指定したファイルを解凍します
1
2
3ZipFile.extract(String member,
String path,
String password = "") async;
呼び出しパラメータ:
- member: 文字列、解凍するファイル名を指定します
- path: 文字列、解凍するパスを指定します
- password: 文字列、解凍パスワード、デフォルトではパスワードなし
指定したファイルをストリームに解凍します
1
2
3ZipFile.extract(String member,
SeekableStream strm,
String password = "") async;
呼び出しパラメータ:
- member: 文字列、解凍するファイル名を指定します
- strm:SeekableStream、解凍するストリームを指定します
- password: 文字列、解凍パスワード、デフォルトではパスワードなし
extractAll
すべてのファイルを指定されたパスに解凍します
1
2ZipFile.extractAll(String path,
String password = "") async;
呼び出しパラメータ:
- path: 文字列、解凍するパスを指定します
- password: 文字列、解凍パスワード、デフォルトではパスワードなし
write
指定したファイルを圧縮ファイルに書き込みます
1
2
3ZipFile.write(String filename,
String inZipName,
String password = "") async;
呼び出しパラメータ:
- filename: 文字列、書き込むファイルを指定します
- inZipName: 圧縮された文字列zipファイル内のファイル名
- password: 文字列、解凍パスワード、デフォルトではパスワードなし
指定したファイルを圧縮ファイルに書き込みます
1
2
3ZipFile.write(Buffer data,
String inZipName,
String password = "") async;
呼び出しパラメータ:
- data:Buffer、書き込むファイルデータを指定します
- inZipName: 圧縮された文字列zipファイル内のファイル名
- password: 文字列、解凍パスワード、デフォルトではパスワードなし
指定したファイルを圧縮ファイルに書き込みます
1
2
3ZipFile.write(SeekableStream strm,
String inZipName,
String password = "") async;
呼び出しパラメータ:
- strm:SeekableStream、書き込まれるファイル データ ストリームを指定します。
- inZipName: 圧縮された文字列zipファイル内のファイル名
- password: 文字列、解凍パスワード、デフォルトではパスワードなし
close
閉じた開いたzip書類
1ZipFile.close() async;
toString
オブジェクトの文字列表現を返します。通常、「[Native Object]」が返されます。オブジェクトは、独自の特性に従って再実装できます。
1String ZipFile.toString();
返される結果:
- String、オブジェクトの文字列表現を返します。
toJSON
オブジェクトの JSON 形式表現を返します。通常は、オブジェクトによって定義された読み取り可能なプロパティのコレクションを返します。
1Value ZipFile.toJSON(String key = "");
呼び出しパラメータ:
- key: 文字列、使用されません
返される結果:
- Value、シリアル化可能な JSON を含む値を返します