ohayolibs

Version:
Ohayo is a set of essential modules for ohayojp.
30 lines (22 loc) • 943 B
Markdown
---
type: Basic
title: zip
order: 7
subtitle: Zip
cols: 1
module: import { ZipModule } from '@ohayo/components/zip';
---

A Zip file operation based on [jszip](http://stuk.github.io/jszip/).

## Dependencies

```
yarn add file-saver
```

The jszip script file takes the form of lazy loading，you can change the default CDN path (or use the local path) via [Global Configuration](/docs/global-config). By default: `//cdn.bootcss.com/jszip/3.3.0/jszip.min.js`.

## API

### ZipService

Property | Description | Type | Default
----|------|-----|------
`read(fileOrUrl: File | string, options?: JSZip.JSZipLoadOptions)` | Decompression  | `Promise<JSZip>` | -
`create()` | Create a Zip instance for creating a compressed file  | `Promise<JSZip>` | -
`pushUrl(zip: JSZip, path: string, url: string)` | Download the URL resource and write it to zip  | `Promise<void>` | -
`save(zip: JSZip, options?: ZipWriteOptions)` | Save  | `Promise<void>` | -