絵夢の小站

1
// 匹配所有 HTTP Method export
2
type EOFuncHandler = (context: EventContext) => Response | Promise<Response>;
3

4
export interface EventContext { // 传递给Function Handlers的上下文
5
  request: Request; // 客户端请求对象 Request。
6
  params: Record<string, string | any>; // 动态路由 /edge-functions/api/users/[id].js 参数值。
7
}

1
// 匹配所有 HTTP Method export
2
export type EOFuncHandler = (
3
  context: EventContext,
4
) => Response | Promise<Response>;
5

6
export interface EventContext {
7
  // 传递给Function Handlers的上下文
8
  request: Request; // 客户端请求对象 Request。
9
  params: Record<string, string | unknown>; // 动态路由如 /edge-functions/api/users/[id].js 的参数值。
10
}
11

12
export interface EO_KV {
13
  put(
14
    // 写入 KV 数据，用于创建新的键值对或者更新已有键值对的值。
15
    key: string,
16
    // 需要创建或更新的键，长度小于等于 512 B，仅支持数字、字母及下划线。仅支持单个键。
17
    value: string | ArrayBuffer | ArrayBufferView | ReadableStream,
18
    // 需要写入的数据，数据长度小于等于 25 MB。
19
    options?: { expirationTtl?: number },
20
    // 可以使用 expirationTtl 来指定过期时间，单位为秒，必须大于60s。
21
  ): Promise<void>; // 返回一个 Promise，需要 await 该 Promise 以验证写入是否成功。
22
  get(key: string): Promise<string | null>;
23
  get(key: string, options: { type: "text" }): Promise<string | null>;
24
  get(key: string, options: { type: "json" }): Promise<object | null>;
25
  get(
26
    // 根据特定的 key 读取 KV 中的数据，并根据指定类型返回数据。
27
    key: string, // 指定获取数据的 key。暂不支持批量获取。
28
    config?: { type: string }, // 用于指定返回的 value 类型，默认为 text。
29
    // text：String，将 value 转成 string 的形式返回。
30
    // json: Object，用于将 json 反序列化为 object 形式返回。
31
    // arrayBuffer: ArrayBuffer，用于将二进制的 value 转换为 ArrayBuffer 返回。
32
    // stream：ReadableStream，通常用于 value 较大的场景。
33
  ): Promise<string | object | ArrayBuffer | ArrayBufferView | ReadableStream>; // 返回一个 Promise。如果 key 不存在或 value 为空时，则返回 null。
34
  delete(
35
    // 从 KV 中删除指定的 key。
36
    key: string, // 需要删除的键值对的 key。
37
  ): Promise<void>; // 返回一个 Promise，需要 await 该 Promise 以验证删除是否成功。
38
  list(config: {
39
    // 用于遍历 KV 中的所有 key。
40
    prefix?: string; // 用于过滤指定前缀的键。默认为空时，按照字典序排序返回。
41
    limit?: number; // 返回的 key 的最大数量，用于分页。默认值为 256，上限为 256。
42
    cursor?: string; // 游标，从指定键开始遍历，用于分页。默认为空。
43
  }): Promise<null | {
44
    complete: boolean; // 标记 list 操作是否完成，true 完成，false 未完成。
45
    cursor: string | null; // 游标，为下一页的第一个 key，当 list 遍历完成时为 null。
46
    keys?: Array<{
47
      // 描述每个 key 的 object 数组。如果没有查询到任何 key，keys 为空。
48
      key: string; // 键值对的 key。
49
      expirationTtl: number; // 过期时间，单位为秒。
50
      expiration: number; // 过期时间戳(秒戳)
51
      meta: string; // ? 未知
52
    }>;
53
  }>;
54
}

1
declare const MY_KV: EO_KV;

1
const page = await my_kv.list({
2
  prefix: '',
3
  cursor,
4
  limit: 10,
5
});
6
const keys = Array.isArray(page?.keys) ? page.keys : [];
7
const values = await Promise.all(
8
  keys.map(async (item) => {
9
    const value = await my_kv.get(item.key);
10
    return {
11
      key: item.key,
12
      value,
13
      ttl: item.ttl,
14
      meta: item.meta,
15
    };
16
  })
17
);
18
allItems.push(...values);