Handle asar file in browser. (Readonly)
AJAX demo: https://toyobayashi.github.io/browser-asar/
File input demo: https://toyobayashi.github.io/browser-asar/file.html
Running demo: https://toyobayashi.github.io/browser-asar/test.html
Support IE 10+ (require Uint8Array)
You can find examples in docs/ and test/.
<!-- Get it from package.json "main" field -->
<script src="asar.js"></script>var xhr = new XMLHttpRequest();
xhr.onload = function () {
var buf = new Uint8Array(xhr.response);
var fs;
try {
fs = new asar.Filesystem(buf);
} catch (err) {
throw new Error('Invalid asar file: ' + err.message);
}
// Then you can do something like Node.js `fs` module.
// Note the asar package is readonly.
// Available API list can be found below.
// fs.readFileSync(...)
// fs.existsSync(...)
// fs.statSync(...).isDirectory()
// ...
// Run as a Node.js project folder
var ms = new asar.Modulesystem(fs);
ms.run();
};
xhr.open('GET', './test.asar', true);
xhr.responseType = 'arraybuffer';
xhr.send();Available builtin modules in asar package:
-
path- posix part only -
fs -
module
declare class Stat {
constructor(info: any);
readonly size: number;
isUnpacked(): boolean;
isDirectory(): boolean;
isFile(): boolean;
isSymbolicLink(): boolean;
}
declare class Module {
constructor(id: string, parent: Module | null);
id: string;
filename: string;
path: string;
parent: Module | null;
loaded: boolean;
exports: any;
children: Module[];
paths: string[];
require(mod: string): any;
}
export declare class Filesystem {
constructor(buffer: Uint8Array);
readonly buffer: Uint8Array;
readonly header: { files: { [item: string]: any } };
readonly headerSize: number;
listFiles(options?: { isPack?: boolean }): string[];
readFileSync(p: string): Uint8Array;
readFileSync(p: string, toUtf8: true): string;
readdirSync(p: string): string[];
existsSync(p: string): boolean;
statSync(p: string): Stat;
lstatSync(p: string): Stat;
}
export declare class Modulesystem {
constructor(fs: Filesystem | Uint8Array);
static run(fs: Filesystem, entry?: string): any;
static inject(moduleName: string, m: any): void;
static require(moduleName: string): any;
static extend(ext: string, compilerFactory: (require: (moduleName: string) => any) => (module: Module, filename: string) => void): void;
run(entry?: string): any;
inject(moduleName: string, m: any): void;
require(moduleName: string): any;
extend(ext: string, compilerFactory: (this: Modulesystem, require: (this: Modulesystem, moduleName: string) => any) => (module: Module, filename: string) => void): void;
}
export as namespace asar;
React
Typescript
Django
Laravel
Facebook
Microsoft
Google
Alibaba
D3
Tencent