Edge 运行时 (Edge Runtime)
Next.js 提供了两种可在应用程序中使用的服务端运行时:
注意事项
- Edge Runtime 不支持所有 Node.js API。某些包可能无法按预期工作。
- Edge Runtime 不支持增量静态再生 (ISR)。
- 根据您的部署适配器,两种运行时均可支持 流式传输。
参考
Edge Runtime 支持以下 API:
网络 API
API | 描述 |
---|---|
Blob | 表示一个 blob 对象 |
fetch | 获取资源 |
FetchEvent | 表示一个 fetch 事件 |
File | 表示一个文件 |
FormData | 表示表单数据 |
Headers | 表示 HTTP 标头 |
Request | 表示一个 HTTP 请求 |
Response | 表示一个 HTTP 响应 |
URLSearchParams | 表示 URL 查询参数 |
WebSocket | 表示一个 WebSocket 连接 |
编码 API
API | 描述 |
---|---|
atob | 解码 base-64 编码的字符串 |
btoa | 将字符串编码为 base-64 |
TextDecoder | 将 Uint8Array 解码为字符串 |
TextDecoderStream | 可链式调用的流解码器 |
TextEncoder | 将字符串编码为 Uint8Array |
TextEncoderStream | 可链式调用的流编码器 |
流 API
API | 描述 |
---|---|
ReadableStream | 表示一个可读流 |
ReadableStreamBYOBReader | 表示 ReadableStream 的读取器 |
ReadableStreamDefaultReader | 表示 ReadableStream 的默认读取器 |
TransformStream | 表示一个转换流 |
WritableStream | 表示一个可写流 |
WritableStreamDefaultWriter | 表示 WritableStream 的写入器 |
加密 API
API | 描述 |
---|---|
crypto | 提供对平台加密功能的访问 |
CryptoKey | 表示一个加密密钥 |
SubtleCrypto | 提供对常见加密原语的访问,如哈希、签名、加密或解密 |
Web 标准 API
API | 描述 |
---|---|
AbortController | 允许在需要时中止一个或多个 DOM 请求 |
Array | 表示一组值的数组 |
ArrayBuffer | 表示一个通用的、固定长度的原始二进制数据缓冲区 |
Atomics | 提供原子操作作为静态方法 |
BigInt | 表示任意精度的整数 |
BigInt64Array | 表示一个 64 位有符号整数的类型化数组 |
BigUint64Array | 表示一个 64 位无符号整数的类型化数组 |
Boolean | 表示一个逻辑实体,可以有两个值:true 和 false |
clearInterval | 取消之前通过 setInterval() 设置的定时重复操作 |
clearTimeout | 取消之前通过 setTimeout() 设置的定时重复操作 |
console | 提供对浏览器调试控制台的访问 |
DataView | 表示 ArrayBuffer 的通用视图 |
Date | 以平台无关的格式表示单个时间点 |
decodeURI | 解码之前由 encodeURI 或类似例程创建的统一资源标识符 (URI) |
decodeURIComponent | 解码之前由 encodeURIComponent 或类似例程创建的 URI 组件 |
DOMException | 表示 DOM 中发生的错误 |
encodeURI | 通过将某些字符的每个实例替换为一个、两个、三个或四个表示该字符 UTF-8 编码的转义序列来编码 URI |
encodeURIComponent | 通过将某些字符的每个实例替换为一个、两个、三个或四个表示该字符 UTF-8 编码的转义序列来编码 URI 组件 |
Error | 表示尝试执行语句或访问属性时发生的错误 |
EvalError | 表示与全局函数 eval() 相关的错误 |
Float32Array | 表示一个 32 位浮点数的类型化数组 |
Float64Array | 表示一个 64 位浮点数的类型化数组 |
Function | 表示一个函数 |
Infinity | 表示数学上的无穷大值 |
Int8Array | 表示一个 8 位有符号整数的类型化数组 |
Int16Array | 表示一个 16 位有符号整数的类型化数组 |
Int32Array | 表示一个 32 位有符号整数的类型化数组 |
Intl | 提供对国际化 (i18n) 和本地化 (l10n) 功能的访问 |
isFinite | 判断一个值是否为有限数 |
isNaN | 判断一个值是否为 NaN |
JSON | 提供将 JavaScript 值与 JSON 格式相互转换的功能 |
Map | 表示一组值的集合,其中每个值只能出现一次 |
Math | 提供对数学函数和常量的访问 |
Number | 表示一个数值 |
Object | 表示作为所有 JavaScript 对象基础的对象 |
parseFloat | 解析字符串参数并返回一个浮点数 |
parseInt | 解析字符串参数并返回指定基数的整数 |
Promise | 表示异步操作的最终完成(或失败)及其结果值 |
Proxy | 表示一个对象,用于定义基本操作(如属性查找、赋值、枚举、函数调用等)的自定义行为 |
queueMicrotask | 将微任务加入队列以执行 |
RangeError | 表示当一个值不在允许的值集合或范围内时发生的错误 |
ReferenceError | 表示引用不存在的变量时发生的错误 |
Reflect | 提供可拦截的 JavaScript 操作方法 |
RegExp | 表示一个正则表达式,允许匹配字符组合 |
Set | 表示一组值的集合,其中每个值只能出现一次 |
setInterval | 以固定的时间间隔重复调用函数 |
setTimeout | 在指定的毫秒数后调用函数或计算表达式 |
SharedArrayBuffer | 表示一个通用的、固定长度的原始二进制数据缓冲区 |
String | 表示一个字符序列 |
structuredClone | 创建一个值的深拷贝 |
Symbol | 表示一个唯一且不可变的数据类型,用作对象属性的键 |
SyntaxError | 表示尝试解释语法无效的代码时发生的错误 |
TypeError | 表示当一个值的类型不符合预期时发生的错误 |
Uint8Array | 表示一个 8 位无符号整数的类型化数组 |
Uint8ClampedArray | 表示一个 8 位无符号整数的类型化数组,数值被限制在 0-255 之间 |
Uint32Array | 表示一个 32 位无符号整数的类型化数组 |
URIError | 表示以错误方式使用全局 URI 处理函数时发生的错误 |
URL | 表示一个提供用于创建对象 URL 的静态方法的对象 |
URLPattern | 表示一个 URL 模式 |
URLSearchParams | 表示一组键/值对的集合 |
WeakMap | 表示一组键/值对的集合,其中键是弱引用的 |
WeakSet | 表示一组对象的集合,其中每个对象只能出现一次 |
WebAssembly | 提供对 WebAssembly 的访问 |
Next.js 专属 Polyfills
环境变量
你可以使用 process.env
来访问环境变量,无论是在 next dev
还是 next build
模式下。
不受支持的 API
Edge 运行时存在一些限制,包括:
- 不支持原生 Node.js API。例如,无法读写文件系统。
- 可以使用
node_modules
,只要它们实现了 ES 模块且未使用原生 Node.js API。 - 不允许直接调用
require
。请改用 ES 模块。
以下 JavaScript 语言特性被禁用,将无法工作:
API | 描述 |
---|---|
eval | 执行以字符串形式表示的 JavaScript 代码 |
new Function(evalString) | 根据提供的代码字符串创建一个新函数 |
WebAssembly.compile | 从缓冲区源编译 WebAssembly 模块 |
WebAssembly.instantiate | 从缓冲区源编译并实例化 WebAssembly 模块 |
在极少数情况下,你的代码可能包含(或导入)一些动态代码评估语句,这些语句在运行时无法被访问且无法通过 treeshaking 移除。
你可以通过中间件配置放宽检查,允许特定文件:
unstable_allowDynamic
是一个 glob 或 glob 数组,用于忽略特定文件的动态代码评估检查。这些 glob 路径相对于应用程序的根目录。
请注意,如果这些语句在 Edge 环境中执行,它们会抛出错误并导致运行时故障。