node-unrar-js
electron-unrar-js
is a fork of https://github.com/YuJianrong/node-unrar.js || https://www.npmjs.com/package/node-unrar-js
electron-unrar.js
is a npm module to extract rar archive in pure JavaScript. It's combined by a Javascript adoption layer and JavaScript unRar library compiled by Emscripten from the C++ unrar library from http://www.rarlab.com/rar_add.htm .
Installation
You can install the module via npm
:
npm install electron-unrar-js
Features
- Fully support for RAR archive, because it comes from the official source code.
- Unicode support, for both comment and file path/name.
- API for Extraction to both memory and file system.
Unsupported Features
- Volume archives are not supported.
- Synchronize File System IO functions are used in File Extraction for the limitation of the library.
- Files must be extracted at once now, can not be extracted one by one for progress indicator (may be improved later).
API to create the extractor
-
createExtractorFromData(data: ArrayBuffer, password?: string)
- Create the Memory ExtractorOptions:
data
: ArrayBuffer object of the RAR archive file.password
: Optional string for extraction password
-
createExtractorFromFile(filepath: string, targetPath?: string, password?: string)
- Get the File ExtractorOptions:
filepath
: File path of the RAR archive file.targetPath
: Optional string target folderpassword
: Optional string for extraction password
API of the extractor
getFileList()
: Get the file list of the archive. Return:[state, result]
- If function call failed
- the state will be
{state: "FAIL", reason: <FailReason>, msg: <string>}
- the result will be
null
.
- the state will be
- When function call success
- the state will be
{state: "SUCCESS"}
- the result will be like:
- the state will be
- If function call failed
arcHeader: comment: "" flags: authInfo: false headerEncrypted: false lock: false recoveryRecord: false solid: false volume: false fileHeaders: crc: 0 flags: directory: false encrypted: false solid: false method: "Storing" name: "FileName" packSize: 0 time: "2017-04-03T10:41:42.000" unpSize: 0 unpVer: "2.9" // ...
-
extractAll()
: Extract all the files.Return:
[state, result]
- If function call failed, the response will be structed like return value above.
- When function call success
- the result will be like:
arcHeader: ... // Same as the arcHeader above files: fileHeader: ... // Same as the fileHeader above extract: state extractedContent
The state
above will be same as the state of the return above, and the extractedContent
will be null
if file extract failed or in File extraction mode.
If extracted successful, the extractedContent
will be Uint8Array
object.
-
extractFiles(files: string[], password?: string)
: Extract the specific filesOption:
files
: File path list to be extracted.password
: A different to main password may be set on these specific files.
Return:
Same to the return value of
extractAll()
, the result will be stored in the same order of the input arrayfiles
. If the specific file is not found in the archive, thefile
item of thefiles
array will benull
.
Example
var fs = ;var unrar = ; // Read the archive file into a typedArrayvar buf = Uint8Arraybuffer;var extractor = unrar; var list = extractor;if list0state === "SUCCESS" list1arcHeader... list1fileHeaders... var extracted = extractor;var extracted = extractor;if list0state === "SUCCESS" list1arcHeader... list1files0fileHeader: if list1files0extract0state === "SUCCESS" list1files0extract1 // Uint8Array
License
This module is licensed under MIT.
Changelog
1.0.0: Updated for Electron and Browser based Node apps
- First release