Skip to content

PWA Assets Generator API

From v0.1.0, @vite-pwa/assets-generator is shipped with a CLI and an API (low-level api).

@vite-pwa/assets-generator is bundler/framework agnostic, you can use it in any project: right now, there is no integration available, we're working on this (stay tuned).

The API can be found in the api folder.

Installation

This package is shipped with the @vite-pwa/assets-generator package:

bash
pnpm add -D @vite-pwa/assets-generator
bash
yarn add -D @vite-pwa/assets-generator
bash
npm install -D @vite-pwa/assets-generator

API

As mentioned previously, the API is low-level, it means that you have to handle the default values yourself: you can check the default values in the defauls.ts module.

The CLI has been rebuilt on top of the API, you can check the CLI documentation for more details about the default values.

The API can be found in the api folder and the JSDOCS documentationJSDOCS.

Released under the MIT License.