Blob

npm install @edgeone/pages-blob

import { getStore } from "@edgeone/pages-blob";

export async function onRequest({ request }) {
  const store = getStore("my-store");

  // Write
  await store.set("hello.txt", "Hello, EdgeOne Pages!");

  const content = await store.get("hello.txt");

  return new Response(content);
}

import { getStore, listStores } from "@edgeone/pages-blob";

const store = getStore("my-store");

// You can also use the object form, which makes it convenient to specify a default consistency level at the same time.
const store = getStore({ name: "my-store", consistency: "strong" });

const store = getStore({
  name: "my-store",
  projectId: "pages-urtsvuwmfvli",
  token: "your-api-token",
});

await store.set("photos/cat.jpg", imageBuffer);
await store.set("notes/todo.txt", "Buy milk");

// Prevent overwriting: Writes only when the Key does not exist.
await store.set("init.json", data, { onlyIfNew: true });

await store.setJSON("user/preferences", { theme: "dark", lang: "zh-CN" });

const text = await store.get("hello.txt");
const json = await store.get("config.json", { type: "json" });
const buffer = await store.get("image.png", { type: "arrayBuffer" });
const blob = await store.get("video.mp4", { type: "blob" });
const stream = await store.get("large-file.zip", { type: "stream" });

// Strongly consistent read
const fresh = await store.get("counter", { consistency: "strong" });

const result = await store.getWithHeaders("document.pdf");
// result.body — object content
// result.headers — complete response headers (content-type, etag, cache-control, etc.)

Promise<{
  body: string;
  headers: Record<string, string>;
} | null>

await store.delete("photos/cat.jpg");

// Lists all objects
const { blobs } = await store.list();

// Filters by prefix
const { blobs } = await store.list({ prefix: "photos/" });

// Groups by directory (returns only files and subdirectories at the current level)
const { blobs, directories } = await store.list({
  prefix: "photos/",
  directories: true,
});

// Strong consistency
const { blobs } = await store.list({ consistency: "strong" });

// Manual pagination
const page1 = await store.list({ paginate: false });
const page2 = await store.list({ paginate: false, cursor: page1.cursor });

{
  blobs: Array<{ key: string; etag: string }>;
  directories?: string[];  // Returned only when directories: true
  cursor?: string;         // Returned only when paginate: false
}

import { listStores } from "@edgeone/pages-blob";

// In Pages Functions
const { stores } = await listStores();

// External access
const { stores } = await listStores({
  projectId: "pages-urtsvuwmfvli",
  token: "your-api-token",
});

{
  stores: Array<{ name: string }>;
}

import { getStore } from "@edgeone/pages-blob";

export async function onRequest({ request }) {
  const store = getStore("user-uploads");
  const url = new URL(request.url);
  const prefix = url.searchParams.get("path") || "";

  const { blobs, directories } = await store.list({
    prefix,
    directories: true,
  });

  return new Response(
    JSON.stringify({ files: blobs, folders: directories }),
    { headers: { "Content-Type": "application/json" } }
  );
}

import { getStore } from "@edgeone/pages-blob";

export async function onRequest({ request }) {
  const store = getStore("configs");

  // Writes only when the Key does not exist, preventing overwriting of existing data.
  await store.setJSON("app/settings", { version: 1 }, { onlyIfNew: true });

  const settings = await store.get("app/settings", { type: "json" });
  return new Response(JSON.stringify(settings), {
    headers: { "Content-Type": "application/json" },
  });
}