跳到内容

Edge Runtime

Next.js 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用于流的可链接编码器

Stream 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表示钳制在 0-255 范围内的 8 位无符号整数的类型化数组
Uint32Array表示 32 位无符号整数的类型化数组
URIError表示全局 URI 处理函数使用方式错误时发生的错误
URL表示提供用于创建对象 URL 的静态方法的对象
URLPattern表示 URL 模式
URLSearchParams表示键/值对的集合
WeakMap表示键/值对的集合,其中键是弱引用的
WeakSet表示对象集合,其中每个对象只能出现一次
WebAssembly提供对 WebAssembly 的访问

Next.js 特定 Polyfills

环境变量

您可以使用 process.env 访问 环境变量,用于 next devnext build

不支持的 API

Edge Runtime 有一些限制,包括

  • 不支持 原生 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 配置允许特定文件

middleware.ts
export const config = {
  unstable_allowDynamic: [
    // allows a single file
    '/lib/utilities.js',
    // use a glob to allow anything in the function-bind 3rd party module
    '**/node_modules/function-bind/**',
  ],
}

unstable_allowDynamic 是一个 glob,或 globs 数组,用于忽略特定文件的动态代码求值。glob 相对于您的应用程序根文件夹。

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