src/types.ts

Functions

None: it only declares types or values.

Imports

It imports no other module of this repo. Imported by src/backup.ts, src/cloudflare.ts, src/drill.ts, src/dump.ts, src/index.ts, src/node.ts, src/r2.ts, src/restore.ts, src/runs.ts, src/schema.ts.

Source

1// The parts of the D1 and R2 bindings this package calls, declared here so a site
2// needs no Cloudflare type package to install it. A Worker's real bindings satisfy
3// these, and so do Miniflare's in the tests.
4
5export interface D1Statement {
6  bind(...values: unknown[]): D1Statement;
7  all<T = Record<string, unknown>>(): Promise<{ results: T[] }>;
8  run(): Promise<unknown>;
9}
10
11export interface D1Like {
12  prepare(sql: string): D1Statement;
13  batch<T = Record<string, unknown>>(statements: D1Statement[]): Promise<Array<{ results: T[] }>>;
14}
15
16export interface R2UploadedPartLike {
17  partNumber: number;
18  etag: string;
19}
20
21export interface R2MultipartLike {
22  uploadPart(partNumber: number, value: Uint8Array): Promise<R2UploadedPartLike>;
23  complete(parts: R2UploadedPartLike[]): Promise<unknown>;
24  abort(): Promise<void>;
25}
26
27export interface R2Like {
28  put(key: string, value: string, options?: { httpMetadata?: { contentType?: string } }): Promise<unknown>;
29  get(key: string): Promise<{ text(): Promise<string> } | null>;
30  list(options: { prefix?: string; cursor?: string }): Promise<{ objects: Array<{ key: string }>; truncated: boolean; cursor?: string }>;
31  delete(keys: string | string[]): Promise<void>;
32  createMultipartUpload(key: string, options?: { httpMetadata?: { contentType?: string } }): Promise<R2MultipartLike>;
33}