API Reference

364 symbols across 6 packages, generated at build time from the published per-package JSON.

@unplugin-pwa/core

119 symbol(s)

• DevOptions  Interface
• ExternalVitePWAOptions  Interface
• IconResource  Interface
• ManifestOptions  Interface
• ManifestScreenshot  Interface
• ManifestShareTarget  Interface
• ManifestShortcut  Interface
• PWAAssetsIntegrationOptions  Interface
• PWAAssetsOptions  Interface
• RegisterSWData  Interface
• ResolvedPWAAssetsOptions  Interface
• ResolvedVitePWAOptions  Interface
• ShareTargetFiles  Interface
• VitePWAOptions  Interface
• WebManifestData  Interface
• Display  Type Alias
• DisplayOverride  Type Alias
• IconPurpose  Type Alias
• LaunchHandlerClientMode  Type Alias
• ResolvedBuildSW  Type Alias
• ResolvedGenerateSW  Type Alias
• ResolvedInjectManifest  Type Alias
• ScopeExtensionsType  Type Alias
• StringLiteralUnion  Type Alias
• VitePWAStrategy  Type Alias
• additionalManifestEntriesFactory  Function
• buildPwaAsset  Function
• DependenciesResolved  Type Alias
• loadConfiguration  Function
• prepareManifest  Function
• resolveDefaultConfig  Function
• resolvePwaConfiguration  Function
• LoaderType  Type Alias
• DEFAULT_CONFIG_FILES  Variable
• DEV_PWA_ASSETS_NAME  Variable
• DEV_PWA_DUAL_SW_SWITCHER_NAME  Variable
• DEV_PWA_REGISTER_NAME  Variable
• DEV_READY_NAME  Variable
• DEV_REGISTER_SW_NAME  Variable
• DEV_SW_NAME  Variable
• DEV_SW_VIRTUAL  Variable
• DEV_SW_VIRTUAL_VIRTUAL  Variable
• DEV_SWITCHER_NAME  Variable
• FILE_SW_REGISTER  Variable
• INSPECTOR_BASE_PATH  Variable
• INSPECTOR_BASE_PATH_API  Variable
• INSPECTOR_BASE_PATH_URL  Variable
• PWA_ASSETS_HEAD_VIRTUAL  Variable
• PWA_ASSETS_ICONS_VIRTUAL  Variable
• PWA_INFO_VIRTUAL  Variable
• RESOLVED_DEV_SW_VIRTUAL  Variable
• RESOLVED_DEV_SW_VIRTUAL_VIRTUAL  Variable
• RESOLVED_PWA_ASSETS_HEAD_VIRTUAL  Variable
• RESOLVED_PWA_ASSETS_ICONS_VIRTUAL  Variable
• RESOLVED_PWA_INFO_VIRTUAL  Variable
• VIRTUAL_MODULES  Variable
• VIRTUAL_MODULES_MAP  Variable
• VIRTUAL_MODULES_RESOLVED_PREFIX  Variable
• createPWAContext  Function
• createRspackPWAContext  Function
• createViteLegacyPWAContext  Function
• createVitePWAContext  Function
• createWebpackPWAContext  Function
• ConfigurePWAOptions  Interface
• DevSWNames  Interface
• PWABuildContext  Interface
• PWABuildDevContext  Interface
• PWAHooks  Interface
• PWAPluginContext  Interface
• SWNames  Interface
• BuildSWType  Type Alias
• Bundler  Type Alias
• CustomPwaAssetResolver  Type Alias
• ExtractStrategy  Type Alias
• HookResult  Type Alias
• PwaAsset  Type Alias
• createGenerateRegisterSW  Function
• createWebManifestHtmlLink  Function
• prepareSwNamesAndGlobDirectory  Function
• prepareTempFolder  Function
• isDualServiceWorker  Function
• generateRegisterSW  Function
• generateWebManifest  Function
• isAbsolute  Function
• normalizeManifest  Function
• normalizePath  Function
• prepareAdditionalManifestEntriesGenerator  Function
• preparePWAAssetsGenerator  Function
• preparePWAStrategy  Function
• resolveBasePath  Function
• resolveFrom  Function
• resolveSWSrc  Function
• checkForHtmlHead  Function
• injectGenerateRegisterSW  Function
• injectWebManifestHtmlLink  Function
• preparePWAConfigurationData  Function
• prepareServiceWorkerData  Function
• inspectorWithInjectManifestWarning  Variable
• preparePWAContext  Function
• prepareSwNames  Function
• AssetsGeneratorContext  Interface
• ColorSchemeMeta  Interface
• PWAAssetsGenerator  Interface
• PWAAssetsIcons  Interface
• PWAHtmlAssets  Interface
• PWAHtmlLink  Interface
• ResolvedIconAsset  Interface
• generate  Function
• loadAssetsGeneratorContext  Function
• checkHotUpdate  Function
• findIconAsset  Function
• loadInstructions  Function
• resolveHtmlAssets  Function
• transformIndexHtml  Function
• injectManifestIcons  Function
• resolvePWAAssetsOptions  Function
• extractIcons  Function
• mapLink  Function
• resolveInspectorDist  Function

@unplugin-pwa/vite

34 symbol(s)

• VitePWA  Function
• definePwaConfig  Function
• ExternalPWAOptions  Type Alias
• createHmrScript  Function
• defaultServiceWorkerAssetsNormalizer  Variable
• injectHmrScript  Function
• prepareRegisterSw  Function
• prepareSwBuild  Function
• generateVirtualModule  Function
• preparePWAContextDefaults  Function
• preparePWAStrategy  Function
• resolveAndValidateBaseUrl  Function
• injectManifestSWAtPublicDir  Function
• ViteLegacyPWA  Function
• BuildPwaAssetsPlugin  Function
• BuildRegisterSWPlugin  Function
• BuildSWPlugin  Function
• DevPlugin  Function
• DevMiddlewarePlugin  Function
• DevAssetsMiddlewarePlugin  Function
• DevtoolsPlugin  Function
• InfoPlugin  Function
• InspectorPlugin  Function
• MainPlugin  Function
• AssetsPlugin  Function
• VirtualModulesPlugin  Function
• pwaAssetsResolver  Function
• createCustomVitePWAContext  Function
• createViteLegacyPWAContext  Function
• createVitePWAContext  Function
• ConfigurePWAOptionsFn  Type Alias
• ServiceWorkerAssetNormalizer  Type Alias
• ViteBundler  Type Alias
• VitePWAPluginContext  Type Alias

@vite-pwa/workbox-build

80 symbol(s)

• generateClassicSW  Function
• generateModernSW  Function
• generateSW  Function
• getManifest  Function
• injectManifest  Function
• selfDestroyingSW  Function
• BasePartial  Interface
• GeneratePartial  Interface
• GetManifestResult  Interface
• GlobPartial  Interface
• InjectPartial  Interface
• ManifestEntry  Interface
• ManifestTransformResult  Interface
• OptionalGlobDirectoryPartial  Interface
• RequiredGlobDirectoryPartial  Interface
• RequiredSWDestPartial  Interface
• RuntimeCaching  Interface
• SelfDestroyingOptions  Interface
• BuildResult  Type Alias
• GenerateSWOptions  Type Alias
• GetManifestOptions  Type Alias
• InjectManifestOptions  Type Alias
• ManifestTransform  Type Alias
• StrategyName  Type Alias
• SWTarget  Type Alias
• SWTargets  Type Alias
• SWType  Type Alias
• BuildSWOptions  Interface
• BundlerLogLevel  Interface
• EnvironmentData  Interface
• BuildGenerateSWOptions  Type Alias
• BuildWithSourcesResult  Type Alias
• CustomAlias  Type Alias
• CustomChunkCallback  Type Alias
• checkBuildSW  Function
• checkGenerateSW  Function
• ServiceWorkerOptions  Interface
• AllResolveOptions  Type Alias
• BuildServiceWorkerOptions  Type Alias
• buildSW  Function
• generateSW  Function
• RspackWorkboxPWAPlugin  Class
• checkBuildSW  Function
• checkGenerateSW  Function
• checkLegacyBuildSW  Function
• checkLegacyGenerateSW  Function
• ServiceWorkerOptions  Interface
• AllResolveOptions  Type Alias
• BuildServiceWorkerOptions  Type Alias
• buildSW  Function
• generateSW  Function
• buildSWLegacy  Function
• generateSWLegacy  Function
• ServiceWorkerOptions  Interface
• LegacyBuildServiceWorkerOptions  Type Alias
• ViteWorkboxPWAPlugin  Function
• VitePWAOptions  Type Alias
• WebpackWorkboxPWAPlugin  Class
• defineOptions  Function
• loadConfiguration  Function
• WorkboxBuildConfiguration  Interface
• WorkboxOptions  Interface
• BuildStrategy  Type Alias
• BuildStrategyOptions  Type Alias
• BuildSWOptions  Type Alias
• GenerateSWOptions  Type Alias
• InjectManifestStrategyOptions  Type Alias
• SelfDestroyingStrategyOptions  Type Alias
• Strategy  Type Alias
• WorkboxBuildOptions  Type Alias
• errStyle  Function
• warnStyle  Function
• StyleFormat  Type Alias
• generateManifestEntries  Function
• extractSwDestNameFromSource  Function
• normalizePath  Function
• resolveSWNames  Function
• anyJsRegexp  Variable
• jsRegexp  Variable
• normalizePathRegexp  Variable

@vite-pwa/workbox-cli

3 symbol(s)

• defineCliOptions  Function
• CliStrategy  Type Alias
• WorkboxCliConfig  Type Alias

@vite-pwa/workbox-swkit

120 symbol(s)

• BackgroundSyncPlugin  Class
• Queue  Class
• OnSyncCallback  Interface
• OnSyncCallbackOptions  Interface
• QueueEntry  Interface
• QueueOptions  Interface
• BroadcastCacheUpdate  Class
• BroadcastUpdatePlugin  Class
• responsesAreSame  Function
• BroadcastCacheUpdateOptions  Interface
• CacheableResponse  Class
• CacheableResponsePlugin  Class
• CacheableResponseOptions  Interface
• clientsClaim  Function
• copyResponse  Function
• registerQuotaErrorCallback  Function
• setCacheNameDetails  Function
• skipWaiting  Function
• CacheDidUpdateCallback  Interface
• CacheDidUpdateCallbackParam  Interface
• CachedResponseWillBeUsedCallback  Interface
• CachedResponseWillBeUsedCallbackParam  Interface
• CacheKeyWillBeUsedCallback  Interface
• CacheKeyWillBeUsedCallbackParam  Interface
• CacheWillUpdateCallback  Interface
• CacheWillUpdateCallbackParam  Interface
• FetchDidFailCallback  Interface
• FetchDidFailCallbackParam  Interface
• FetchDidSucceedCallback  Interface
• FetchDidSucceedCallbackParam  Interface
• HandlerDidCompleteCallback  Interface
• HandlerDidCompleteCallbackParam  Interface
• HandlerDidErrorCallback  Interface
• HandlerDidErrorCallbackParam  Interface
• HandlerDidRespondCallback  Interface
• HandlerDidRespondCallbackParam  Interface
• HandlerWillRespondCallback  Interface
• HandlerWillRespondCallbackParam  Interface
• HandlerWillStartCallback  Interface
• HandlerWillStartCallbackParam  Interface
• ManualHandlerCallback  Interface
• ManualHandlerCallbackOptions  Interface
• MapLikeObject  Interface
• RequestWillFetchCallback  Interface
• RequestWillFetchCallbackParam  Interface
• RouteHandlerCallback  Interface
• RouteHandlerCallbackOptions  Interface
• RouteHandlerObject  Interface
• RouteMatchCallback  Interface
• RouteMatchCallbackOptions  Interface
• WorkboxPlugin  Interface
• WorkboxPluginCallbackParam  Interface
• HandlerCallbackOptions  Type Alias
• PluginState  Type Alias
• RouteHandler  Type Alias
• cacheNames  Variable
• CacheExpiration  Class
• ExpirationPlugin  Class
• ExpirationPluginOptions  Interface
• disable  Function
• enable  Function
• isSupported  Function
• PrecacheController  Class
• PrecacheFallbackPlugin  Class
• PrecacheRoute  Class
• PrecacheStrategy  Class
• addPlugins  Function
• addRoute  Function
• cleanupOutdatedCaches  Function
• createHandlerBoundToURL  Function
• getCacheKeyForURL  Function
• matchPrecache  Function
• precache  Function
• precacheAndRoute  Function
• CleanupResult  Interface
• InstallResult  Interface
• Parallel  Interface
• PrecacheEntry  Interface
• PrecacheOptions  Interface
• PrecacheRouteOptions  Interface
• urlManipulation  Type Alias
• RangeRequestsPlugin  Class
• createPartialResponse  Function
• googleFontsCache  Function
• imageCache  Function
• offlineFallback  Function
• pageCache  Function
• staticResourceCache  Function
• warmStrategyCache  Function
• GoogleFontCacheOptions  Interface
• ImageCacheOptions  Interface
• OfflineFallbackOptions  Interface
• PageCacheOptions  Interface
• StaticResourceOptions  Interface
• WarmStrategyCacheOptions  Interface
• NavigationRoute  Class
• RegExpRoute  Class
• Route  Class
• Router  Class
• registerRoute  Function
• setCatchHandler  Function
• setDefaultHandler  Function
• NavigationRouteMatchOptions  Interface
• HTTPMethod  Type Alias
• CacheFirst  Class
• CacheOnly  Class
• NetworkFirst  Class
• NetworkOnly  Class
• StaleWhileRevalidate  Class
• Strategy  Class
• StrategyHandler  Class
• NetworkFirstOptions  Interface
• NetworkOnlyOptions  Interface
• StrategyOptions  Interface
• concatenate  Function
• concatenateToResponse  Function
• isSupported  Function
• strategy  Function
• StreamsHandlerCallback  Interface
• StreamSource  Type Alias

@vite-pwa/workbox-window

8 symbol(s)

• Workbox  Class
• messageSW  Function
• WorkboxEventMap  Interface
• WorkboxLifecycleEvent  Interface
• WorkboxLifecycleEventMap  Interface
• WorkboxLifecycleWaitingEvent  Interface
• WorkboxMessageEvent  Interface
• isServiceWorkerModuleSupported  Function