To help you get started, we've collected the most common ways that adm-zip is being used within popular public projects.

aws-samples / cloudfront-authorization-at-edge / src / cfn-custom-resources / lambda-code-update / index.ts View on Github

async function updateLambdaCode(action: 'Create' | 'Update' | 'Delete', lambdaFunction: string, configuration: string, physicalResourceId?: string) {
    if (action === 'Delete') {
        // Deletes aren't executed; the Lambda Resource should just be deleted
        return { physicalResourceId: physicalResourceId!, Data: {} };
    }
    console.log(`Adding configuration to Lambda function ${lambdaFunction}:\n${configuration}`);
    const { Code } = await LAMBDA_CLIENT.getFunction({ FunctionName: lambdaFunction }).promise();
    const { data } = await axios.get(Code!.Location!, { responseType: 'arraybuffer' });

    // Extract Lambda zip contents to temporary folder, add configuration.json, and rezip
    const lambdaZip = new Zip(data);
    console.log('Lambda zip contents:', lambdaZip.getEntries().map(entry => entry.name));
    console.log('Adding (fresh) configuration.json ...');
    const tempDir = mkdtempSync('/tmp/lambda-package');
    lambdaZip.extractAllTo(tempDir, true);
    writeFileSync(resolve(tempDir, 'configuration.json'), Buffer.from(configuration));
    const newLambdaZip = new Zip();
    newLambdaZip.addLocalFolder(tempDir);
    console.log('New Lambda zip contents:', newLambdaZip.getEntries().map(entry => entry.name));
    
    const { CodeSha256, Version, FunctionArn } = await LAMBDA_CLIENT.updateFunctionCode(
        {
            FunctionName: lambdaFunction,
            ZipFile: newLambdaZip.toBuffer(),
            Publish: true
        }
    ).promise();

View more ways to use adm-zip

ADM-ZIP for NodeJS

ADM-ZIP is a pure JavaScript implementation for zip data compression for NodeJS.

Installation

With npm do:

$ npm install adm-zip

Electron file system support described below.

What is it good for?

The library allows you to:

• decompress zip files directly to disk or in memory buffers
• compress files and store them to disk in .zip format or in compressed buffers
• update content of/add new/delete files from an existing .zip

Dependencies

There are no other nodeJS libraries that ADM-ZIP is dependent of

Examples

Basic usage

var AdmZip = require("adm-zip");

// reading archives
var zip = new AdmZip("./my_file.zip");
var password = "1234567890";
var zipEntries = zip.getEntries(); // an array of ZipEntry records - add password parameter if entries are password protected

zipEntries.forEach(function (zipEntry) {
    console.log(zipEntry.toString()); // outputs zip entries information
    if (zipEntry.entryName == "my_file.txt") {
        console.log(zipEntry.getData().toString("utf8"));
    }
});
// outputs the content of some_folder/my_file.txt
console.log(zip.readAsText("some_folder/my_file.txt"));
// extracts the specified file to the specified location
zip.extractEntryTo(/*entry name*/ "some_folder/my_file.txt", /*target path*/ "/home/me/tempfolder", /*maintainEntryPath*/ false, /*overwrite*/ true);
// extracts everything
zip.extractAllTo(/*target path*/ "/home/me/zipcontent/", /*overwrite*/ true);

// creating archives
var zip = new AdmZip();

// add file directly
var content = "inner content of the file";
zip.addFile("test.txt", Buffer.from(content, "utf8"), "entry comment goes here");
// add local file
zip.addLocalFile("/home/me/some_picture.png");
// get everything as a buffer
var willSendthis = zip.toBuffer();
// or write everything to disk
zip.writeZip(/*target file name*/ "/home/me/files.zip");

// ... more examples in the wiki

For more detailed information please check out the wiki.

Electron original-fs

ADM-ZIP has supported electron original-fs for years without any user interractions but it causes problem with bundlers like rollup etc. For continuing support original-fs or any other custom file system module. There is possible specify your module by fs option in ADM-ZIP constructor.

Example:

const AdmZip = require("adm-zip");
const OriginalFs = require("original-fs");

// reading archives
const zip = new AdmZip("./my_file.zip", { fs: OriginalFs });
.
.
.