asar-peeker v1.2.0
asar-peeker
A lightweight, browser-friendly library for reading Asar files.
Overview
asar-lite is split among two diffent utilities.
openAsar.js ~.3kb
Exposes the openAsar function which simply breaks up the archive into it's header and file contents. Great for lazy people who want granular control.
Asar.js ~1kb
This provides the Asar class which acts as a basic interface to retrieve files from the archive, easily extensible!
Documentation
Classes
Functions
Typedefs
Asar
An Asar archive
Kind: global class
- Asar
- new Asar(archive)
- .find(path) ⇒ Object
- .get(path) ⇒ ArrayBuffer
new Asar(archive)
| Param | Type | Description |
|---|---|---|
| archive | ArrayBuffer | The archive to open |
asar.find(path) ⇒ Object
Retrieves information on a directory or file from the archive's header
Kind: instance method of Asar
| Param | Type | Description |
|---|---|---|
| path | ArchivePath | The path to the dirent |
asar.get(path) ⇒ ArrayBuffer
Open a file in the archive
Kind: instance method of Asar
Returns: ArrayBuffer - The file's contents
| Param | Type | Description |
|---|---|---|
| path | ArchivePath | The path to the file |
openAsar(archive) ⇒ ArchiveData
Kind: global function
| Param | Type | Description |
|---|---|---|
| archive | ArrayBuffer | Asar archive to open |
ArchivePath : String
These paths must be absolute and posix-style, without a leading forward slash.
Kind: global typedef
ArchiveData : Object
Kind: global typedef
Properties
| Name | Type | Description |
|---|---|---|
| header | Object | The asar file's manifest, containing the pointers to each index's files in the buffer |
| buffer | ArrayBuffer | The contents of the archive, concatenated together. |