Skip to content

VeraeLLC/zenfs-zip

 
 

Repository files navigation

ZenFS Zip Backend

ZenFS backend for Zip files.

Please read the ZenFS documentation!

Backend

This package adds the Zip backend, which allows you to create a readonly file system from a zip file.

For more information, see the API documentation.

Usage

Note

The examples are written in ESM.
For CJS, you can require the package.
If using a browser environment, you can use a <script> with type=module (you may need to use import maps)

You can't use Zip on its own. You must import the core in order to use the backend.

import { configure, fs } from '@zenfs/core';
import { Zip } from '@zenfs/zip';

const res = await fetch('http://example.com/archive.zip');

await configure({
	mounts: {
		'/mnt/zip': { backend: Zip, data: await res.arrayBuffer() },
	},
});

const contents = fs.readFileSync('/mnt/zip/in-archive.txt', 'utf-8');
console.log(contents);

About

ZenFS Backend for zip files

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 98.8%
  • JavaScript 1.2%