RuntimeAPI手册

本文档用于呈现ESA边缘函数所支持的各类常用函数,为您提供便捷高效的信息查询体验,便于您快速了解到您想要的函数信息。

Web APIs

Streams

API名称

API说明

其它

ByteLengthQueuingStrategy

提供了一个队列策略,该队列策略提供了内置的字节长度并且可以在构造流的时候使用。

接口参考文档

CountQueuingStrategy

提供了一个内置的、用于对分块进行计数的队列策略,可以在构造流的时候使用。

接口参考文档

ReadableStream

表示可读的字节数据流。Fetch API通过Response的属性body提供了一个具体的ReadableStream对象。

接口参考文档

ReadableStreamDefaultReader

表示一个用于读取来自网络提供的流数据(例如 fetch 请求)的默认 reader。

接口参考文档

ReadableByteStreamController

表示可读的字节数据流的控制器。它提供对ReadableStream对象状态和内部队列的控制。

接口参考文档

ReadableStreamBYOBReader

用于ReadableStream的读取操作,支持从底层字节源进行零拷贝读取,常用于需要高效数据拷贝的场景。

接口参考文档

ReadableStreamBYOBRequest

接口参考文档

ReadableStreamDefaultController

表示是一个控制器,该控制器允许控制ReadableStream的状态和内部队列。默认控制器用于不是字节流的流。

接口参考文档

WritableStream

Stream API 的WritableStream接口为将流数据写入目的地(称为接收器)提供了一个标准的抽象。该对象带有内置的背压和队列。

接口参考文档

WritableStreamDefaultWriter

Stream API 的WritableStreamDefaultWriter口是由WritableStream.getWriter()返回的对象,并且一旦创建就会将 writer 锁定到WritableStream,确保没有其他流可以写入底层 sink。

接口参考文档

WritableStreamDefaultController

表示一个允许控制 WritableStream 状态的控制器。当构造 WritableStream 时,会为底层的接收器提供一个相应的 WritableStreamDefaultController 实例以进行操作。

接口参考文档

TransformStream

表示链式管道传输(pipe chain)转换流(transform stream)概念的具体实现。它可以传递给 ReadableStream.pipeThrough() 方法,以便将流数据从一种格式转换成另一种。例如,它可以用于解码(或者编码)视频帧,解压缩数据或者将流从 XML 转换到 JSON。

接口参考文档

TransformStreamDefaultController

接口提供了操作关联的ReadableStream和WritableStream的方法。当构造TransformStream时,会创建一个TransformStreamDefaultController。因此它没有构造函数。获取TransformStreamDefaultController实例的方式是通过TransformStream()的回调方法。

接口参考文档

CompressionStream

一个用于压缩数据流的API

接口参考文档

DecompressionStream

一个用于解压数据流的API

接口参考文档

Encoding/Decoding

API名称

API说明

其它

TextEncoder

接受码位流作为输入,并提供 UTF-8 字节流作为输出。

接口参考文档

TextDecoder

接口表示一个文本解码器,一个解码器只支持一种特定文本编码,例如 UTF-8、ISO-8859-2、KOI8-R、GBK,等等。解码器将字节流作为输入,并提供码位流作为输出。

接口参考文档

TextEncoderStream

TextEncoderStream接口将一个字符串流转换为UTF-8编码的字节。它与TextEncoder的流形式等价。

接口参考文档

TestDecoderStream

接口的TextDecoderStream方法将二进制编码(如UTF-8等)的文本流转换为字符串流。它与TextDecoder的流形式等价。

接口参考文档

atob

解码使用base64进行编码的数据字符串。

接口参考文档

btoa

对输入的数据字符串进行base64编码。

接口参考文档

Web Crypto

API名称

API说明

其它

Crypto

接口提供了当前上下文中可用的基本的加密功能。它允许访问一个密码学安全的随机数生成器和密码学原语(cryptographic primitive)。

接口参考文档

SubtleCrypto

提供了许多底层加密函数。你可以通过crypto属性提供的Crypto对象中的subtle属性来访问SubtleCrypto的相关特性。

接口参考文档

CryptoKey

表示从特定 SubtleCrypto 方法(generateKey()、deriveKey()、importKey() 或 unwrapKey())导出的密钥。

接口参考文档

CryptoKeyPair

表示非对称加密算法的密钥对。

接口参考文档

Timers

API名称

API说明

其它

setInterval

重复调用一个函数或执行一个代码片段,在每次调用之间具有固定的时间间隔。

接口参考文档

clearInterval

取消一个之前通过setInterval()生成的定时重复操作。

接口参考文档

setTimeout

设置一个定时器,在一定的延迟后执行某个函数。

接口参考文档

clearTimeout

取消一个之前通过setTimeout()生成的定时器。

接口参考文档

Console

API名称

API说明

其它

Console

为函数提供了代码调试接口,ESA目前只支持console.log()和console.alert()两种方法,其中log方法用于在控制台调试环境进行debug打印,alert方法用于将关键信息输出至日志中。

接口参考文档

URL

API名称

API说明

其它

URL

URL 接口代表一个对象,提供用于创建对象 URL 的静态方法。

接口参考文档

URLPattern

URLPattern 接口将 URL 或 URL 的一部分与模式进行匹配,用于提取和匹配URL的一部分内容。

接口参考文档

Fetch

API名称

API说明

其它

Fetch

用于发起获取资源的请求,它返回一个会在请求响应后兑现的promise。

Fetch API

Headers

允许你对HTTP请求和响应头执行各种操作,包括检索、设置、添加和删除。

接口参考文档

Request

创建一个新的Request对象,用来表示资源请求。

接口参考文档

RequestInit

表示一系列可以用于Fetch操作的参数,可以将RequestInit对象传递给Request构造函数,也可以直接在fetch()调用时使用。

接口参考文档

Response

用于表示一次请求的响应数据,可以通过构造函数来创建一个Response对象,但通常是通过其他API例如fetch()操作返回一个Response对象。

接口参考文档

WebAssembly

API名称

API说明

其它

Module

创建一个新的 Module 对象,WebAssembly.Module 对象包含已编译的无状态 WebAssembly 代码。

接口参考文档

Instance

WebAssembly.Instance 对象本身是有状态的,是 WebAssembly.Module 的一个可执行实例。Instance 对象包含所有的 WebAssembly 导出函数,允许从 JavaScript 调用 WebAssembly 代码。

接口参考文档

Node APIs

API名称

API说明

其它

assert

提供了一组用于验证不变量的断言函数。

接口参考文档

AsyncLocalStorage

该接口允许在异步操作中存储和传递上下文数据。

接口参考文档

Buffer

Buffer对象用于表示固定长度的字节序列,Buffer API是Node.js中最常用的二进制数据处理接口之一。

接口参考文档

Crypto

Crypto模块了加解密能力,包括哈希、HMAC、签名、验签、加密、解密等函数。

接口参考文档

Diagnostics Channel

用于创建命名管道,从而报告用于诊断目的的数据。

接口参考文档

path

提供用于处理文件和目录路径的接口。

接口参考文档

process

process接口提供和当前进程状态有关的各类数据,目前ESA仅支持env和nextTick两个子接口的调用。

接口参考文档

Streams

流是用于在 Node.js 中处理流数据的抽象接口。node:stream模块提供了用于处理流数据的 API。

接口参考文档

StringDecoder

String Decoder 模块用于将 Buffer 对象解码为字符串。

接口参考文档

util

node:util为许多Node.js内部接口提供底层支持,同时也通过丰富的接口助力开发者进行应用开发。

接口参考文档

ESA APIs

API名称

API说明

其它

Cache API

Cache API是一种缓存数据的方法。通过Cache API,您可以在边缘节点上缓存数据,以便在下次请求时快速返回数据。Cache API可以设置缓存时间和缓存大小,以便更好地控制缓存策略。

Cache API

KV API

边缘节点提供了Key-Value型边缘存储服务。将数据写在边缘存储后,边缘存储的数据会快速自动同步到全球的边缘节点,边缘函数ER可快速读取使用同节点的边缘存储数据。

边缘存储API

HtmlStreaming

HTMLStream API是一种处理HTML流式数据的方法。通过HTMLStream API,您可以在边缘节点上处理HTML流式数据,例如实时更新的股票数据或实时聊天记录。HTMLStream API可以将HTML流式数据分块传输,提高数据传输效率。

HTMLStream API