Skip to content

Latest commit

 

History

History
34 lines (25 loc) · 1.43 KB

README.md

File metadata and controls

34 lines (25 loc) · 1.43 KB

npm Build Status Coverage Status Commitizen friendly

TSZIP

A typescript / javascript library that emulates the python's zip method, providing a similar interface in a javascript / typescript context.

Installation

NPM

npm install tszip

Vanilla JS / Web

Download the latest release from the release section, then include the desired script located in the ´dist´ folder (either dist/lib, either one of the js files in dist, according to what is the targeted environment).

Usage

Examples are directly available in the docs, which will be updated if any change is occurring.

To use the library in an ES6 environment, just import it:

import { tszip } from 'tszip';

Or, if you must use require:

const zip = require('tszip').zip;

There also is an example folder in this repository available providing some example usages. The webpack example is a raw clone of this repository: https://github.com/wbkd/webpack-starter.git, where I'm simply importing the library.