Resource Fallback

简体中文

English

简体中文

English

外观

@resource-fallback/core / index

index ​

Variables ​

RF_PREFIX ​

ts
const RF_PREFIX: "[resource-fallback]" = '[resource-fallback]';

Defined in: error.ts:2

日志与抛错统一使用的产品前缀。

Functions ​

buildInjectedTags() ​

ts
function buildInjectedTags(opts): HtmlTag[];

Defined in: index.ts:136

构建所有需要注入到 HTML 中的 <script> / <link> 标签描述。 webpack 和 vite 插件都调用此函数以确保输出一致的标记。

运行时配置会被序列化并内联；rules 在序列化前会规范化 base/urls 尾斜杠。

Parameters ​

opts ​

ExtendedPluginOptions

Returns ​

HtmlTag[]

defineConfig() ​

ts
function defineConfig<T>(config): T;

Defined in: index.ts:50

恒等辅助函数——让用户在编写配置时获得类型检查和 IDE 悬浮提示。

Type Parameters ​

T ​

T extends PluginOptions

Parameters ​

config ​

T

Returns ​

T

Example ​

ts
import { defineConfig } from '@resource-fallback/core';
  export default defineConfig({ rules: [...] });

ensureTrailingSlash() ​

ts
function ensureTrailingSlash(prefix): string;

Defined in: runtime/utils.ts:16

规范化 URL / 路径前缀的尾斜杠。 空字符串与纯 / 保持原样；其余缺尾 / 或 \ 则补上 /。 供 runtime、Vite 改写闸门与构建期序列化共用。

Parameters ​

prefix ​

string

Returns ​

string

getRuntimeCode() ​

ts
function getRuntimeCode(): string;

Defined in: index.ts:83

读取 IIFE 运行时文件内容。首次调用后缓存。

Returns ​

string

getRuntimePath() ​

ts
function getRuntimePath(): string;

Defined in: index.ts:55

返回 IIFE 运行时文件的绝对路径。

Returns ​

string

getServiceWorkerCode() ​

ts
function getServiceWorkerCode(): string;

Defined in: index.ts:114

读取 Service Worker 运行时代码。源码测试环境未构建时返回占位代码。

Returns ​

string

getServiceWorkerPath() ​

ts
function getServiceWorkerPath(): string;

Defined in: index.ts:91

返回 Service Worker 运行时文件的绝对路径。

Returns ​

string

joinAssetPrefix() ​

ts
function joinAssetPrefix(prefix, filename): string;

Defined in: index.ts:205

拼接 asset 前缀与文件名。

  • 绝对 URL（https?:// 或 / 开头）直接返回 filename
  • 空 filename 返回 prefix（标准化尾部斜杠）
  • 去掉 filename 的前导 /，确保 prefix 与 filename 之间恰好一个 /

Parameters ​

prefix ​

string

filename ​

string

Returns ​

string

normalizeFallbackRule() ​

ts
function normalizeFallbackRule(rule): FallbackRule;

Defined in: runtime/utils.ts:22

校验并规范化单条规则的 base / urls 尾斜杠。

Parameters ​

rule ​

FallbackRule

Returns ​

FallbackRule

normalizeFallbackRules() ​

ts
function normalizeFallbackRules(rules): FallbackRule[];

Defined in: runtime/utils.ts:41

Parameters ​

rules ​

FallbackRule[] | undefined

Returns ​

FallbackRule[]

rfError() ​

ts
function rfError(message): Error;

Defined in: error.ts:5

构造带统一前缀的 Error，便于控制台检索与文档对齐。

Parameters ​

message ​

string

Returns ​

Error

serialiseConfig() ​

ts
function serialiseConfig(cfg): string;

Defined in: index.ts:189

将运行时配置序列化为可嵌入页面的 JS 对象字面量。 序列化前会规范化 rules[].base / urls 的尾斜杠。

Parameters ​

cfg ​

RuntimeConfig & object

Returns ​

string

References ​

buildResourceFallbackManifest ​

Re-exports buildResourceFallbackManifest

buildServiceWorkerAssets ​

Re-exports buildServiceWorkerAssets

CircuitOptions ​

Re-exports CircuitOptions

ErrorEvent ​

Re-exports ErrorEvent

FallbackEvent ​

Re-exports FallbackEvent

FallbackRule ​

Re-exports FallbackRule

HtmlTag ​

Re-exports HtmlTag

HtmlTagAttributes ​

Re-exports HtmlTagAttributes

inferResourceFallbackAssetType ​

Re-exports inferResourceFallbackAssetType

NormalizedServiceWorkerOptions ​

Re-exports NormalizedServiceWorkerOptions

normalizeServiceWorkerOptions ​

Re-exports normalizeServiceWorkerOptions

PluginOptions ​

Re-exports PluginOptions

ResolveResult ​

Re-exports ResolveResult

ResourceFallbackAssetOwner ​

Re-exports ResourceFallbackAssetOwner

ResourceFallbackAssetType ​

Re-exports ResourceFallbackAssetType

ResourceFallbackManifest ​

Re-exports ResourceFallbackManifest

ResourceFallbackManifestAsset ​

Re-exports ResourceFallbackManifestAsset

RetryEvent ​

Re-exports RetryEvent

RetryOptions ​

Re-exports RetryOptions

RuntimeConfig ​

Re-exports RuntimeConfig

RuntimeHooks ​

Re-exports RuntimeHooks

ServiceWorkerOptions ​

Re-exports ServiceWorkerOptions

SriPolicy ​

Re-exports SriPolicy

SuccessEvent ​

Re-exports SuccessEvent