https://github.com/yydounai1234/zeus

Vite serviceWorker 缓存插件，可以缓存 fetch 请求以及缓存 app 加载文件
https://github.com/yydounai1234/zeus

cache-storage service-worker vite vue3

Last synced: 9 days ago
JSON representation

Vite serviceWorker 缓存插件，可以缓存 fetch 请求以及缓存 app 加载文件

• Host: GitHub
• URL: https://github.com/yydounai1234/zeus
• Owner: yydounai1234
• License: mit
• Created: 2022-06-20T02:53:57.000Z (over 2 years ago)
• Default Branch: master
• Last Pushed: 2022-12-02T11:19:13.000Z (almost 2 years ago)
• Last Synced: 2024-10-31T18:29:30.171Z (15 days ago)
• Topics: cache-storage, service-worker, vite, vue3
• Language: TypeScript
• Homepage: https://yydounai1234.github.io/Zeus/
• Size: 90.8 KB
• Stars: 2
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Zeus

**Zeus** 是一个 **vite** 插件，通过简单的插件引入，轻松获得缓存 app 本地文件与 fetch 请求的资源的能力，可以通过 [Zeus](https://yydounai1234.github.io/Zeus/) 查看示例。

## 使用方法

* 下载插件

```javascript

npm install zeus-plugin --save-dev

```

* 在 **vite.config.ts** 中添加插件

```typescript

import zeusPlugin from 'zeus-plugin'

plugins: [...other plugins, zeusPlugin({

    /** cache 版本号 */

    cacheVersion: 1,

    /** sw 版本号 */

    swVersion: 1,

    /** 初始缓存文件 */

    appShellFiles: ["/source.webp"],

    /** 拦截缓存文件的正则 */

    patten: /image|png/

})]

```

完整配置如下：

```typescript

type ZeusOption = Partial<{

  /**

   * 作用域

   */

  scope: string

  /**

   * 前缀

   */

  prefix: string

  /**

   * SW 名

   */

  swName: string

}> & {

  /**

   * SW 版本号

   */

  swVersion: string

  /**

   * 缓存版本号

   */

  cacheVersion: string

  /**

   * 初始缓存文件

   */

  appShellFiles: string[]

  /**

   * 缓存请求正则

   */

  patten: RegExp

}

```

## 本地调试

* 下载依赖

```javascript

    pnpm install

```

* 运行脚本

```javascript

    pnpm run plugin:dev

    pnpm run demo:dev

```

## License

MIT License