Menu

Edge Runtime

Next.js Edge 运行时用于中间件,并支持以下 API:

网络 API

API描述
Blob表示一个 blob 对象
fetch获取资源
FetchEvent表示一个获取事件
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表示一个逻辑实体,可以有两个值:truefalse
clearInterval取消先前通过调用 setInterval() 建立的定时重复动作
clearTimeout取消先前通过调用 setTimeout() 建立的定时动作
console提供对浏览器调试控制台的访问
DataView表示对 ArrayBuffer 的通用视图
Date表示一个独立于平台的时间点
decodeURI解码先前由 encodeURI 或类似例程创建的统一资源标识符 (URI)
decodeURIComponent解码先前由 encodeURIComponent 或类似例程创建的统一资源标识符 (URI) 组件
DOMException表示 DOM 中发生的错误
encodeURI通过将某些字符的每个实例替换为一个、两个、三个或四个转义序列来编码统一资源标识符 (URI),这些序列表示字符的 UTF-8 编码
encodeURIComponent通过将某些字符的每个实例替换为一个、两个、三个或四个转义序列来编码统一资源标识符 (URI) 组件,这些序列表示字符的 UTF-8 编码
Error表示在尝试执行语句或访问属性时发生的错误
EvalError表示与全局函数 eval() 有关的错误
Float32Array表示一个 32 位浮点数的类型化数组
Float64Array表示一个 64 位浮点数的类型化数组
Function表示一个函数
Infinity表示数学上的无穷大值
Int8Array表示一个 8 位有符号整数的类型化数组
Int16Array表示一个 16 位有符号整数的类型化数组
Int32Array表示一个 32 位有符号整数的类型化数组
Intl提供对国际化和本地化功能的访问
isFinite确定一个值是否为有限数
isNaN确定一个值是否为 NaN
JSON提供用于将 JavaScript 值转换为 JSON 格式和从 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 devnext 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 模块

在罕见的情况下,你的代码可能包含(或导入)一些 在运行时无法到达 且无法通过 tree-shaking 移除的动态代码评估语句。 你可以通过中间件配置放宽检查,允许特定文件:

middleware.ts
export const config = {
  unstable_allowDynamic: [
    // 允许单个文件
    "/lib/utilities.js",
    // 使用 glob 模式允许 function-bind 第三方模块中的任何内容
    "/node_modules/function-bind/**",
  ],
};

unstable_allowDynamic 是一个 glob 模式,或 glob 模式数组,用于忽略特定文件的动态代码评估。这些 glob 模式相对于你的应用程序根文件夹。

请注意,如果这些语句在 Edge 上执行,它们将抛出异常并导致运行时错误