pwa.ts#

8 documented symbols. Read the signatures first, then expand each item for parameters, return types, and examples.

8 symbols 4 functions 3 interfaces 1 modules 7 parameters 9 members 4 returns

Reference#

fngeneratePwa(input: PwaRenderInput): PwaRenderResultBuilds manifest / service-worker bodies without writing files.1 paramreturns PwaRenderResult

Builds manifest / service-worker bodies without writing files.

Signature

export function generatePwa(input: PwaRenderInput): PwaRenderResult

View source

Parameters

input PwaRenderInput

Returns

PwaRenderResult

fninjectPwaPageTags(html: string, input: { options?: ResolvedPwaOptions | null; base?: string }): stringInjects rel=manifest (and the service-worker register script when offline) into…4 paramsreturns string

Injects rel=manifest (and the service-worker register script when offline) into a themed HTML document. Bare / fragment HTML is left unchanged.

Signature

export function injectPwaPageTags(html: string, input: { options?: ResolvedPwaOptions | null; base?: string }): string

View source

Parameters

html string
input { options?: ResolvedPwaOptions | null; base?: string }
input.options? ResolvedPwaOptions | null

optional
input.base? string

optional

Returns

string

modulepwaOpt-in web app manifest and conservative service worker. The Vite plugin writes those files during SSG without adding a…

Opt-in web app manifest and conservative service worker.

The Vite plugin writes those files during SSG without adding a NAPI surface. Enabling offline injects a tiny client script that registers sw.js.

View source

interfacePwaRenderInputInputs for rendering PWA file bodies.4 members

Inputs for rendering PWA file bodies.

Signature

export interface PwaRenderInput

View source

Members

Properties

Name	Type	Description
`base`optional	`string`
`options`optional	`ResolvedPwaOptions \| null`
`siteName`optional	`string`
`siteUrl`optional	`string`

interfacePwaRenderResultRendered PWA bodies, or a skip warning.3 members

Rendered PWA bodies, or a skip warning.

Signature

export interface PwaRenderResult

View source

Members

Properties

Name	Type	Description
`manifest`optional	`string`
`serviceWorker`optional	`string`
`warning`optional	`string`

fnresolvePwaOptions(value: boolean | PwaOptions | undefined): ResolvedPwaOptionsResolves pwa with defaults. false / omitted stays off. true enables the manifes…1 paramreturns ResolvedPwaOptions

Resolves pwa with defaults.

false / omitted stays off. true enables the manifest and offline service worker. An object enables the feature and overrides only the fields the site set.

Signature

export function resolvePwaOptions(value: boolean | PwaOptions | undefined): ResolvedPwaOptions

View source

Parameters

value boolean | PwaOptions | undefined

Returns

ResolvedPwaOptions

fnwritePwaFiles(input: WritePwaFilesInput): Promise<{ files: string[]; warning?: string }>Writes enabled PWA files into outDir.1 paramreturns Promise<{ files: string[]; warning?: string }>

Writes enabled PWA files into outDir.

Signature

export async function writePwaFiles(input: WritePwaFilesInput): Promise<{ files: string[]; warning?: string }>

View source

Parameters

input WritePwaFilesInput

Returns

Promise<{ files: string[]; warning?: string }>

interfaceWritePwaFilesInput extends PwaRenderInputInputs for writing PWA files next to generated HTML.2 members

Inputs for writing PWA files next to generated HTML.

Signature

export interface WritePwaFilesInput extends PwaRenderInput

View source

Members

Properties

Name	Type	Description
`base`	`string`
`outDir`	`string`