Interface HostedImagesBinding

interface HostedImagesBinding {
    createDirectUpload(
        options?: ImageDirectUploadOptions,
    ): Promise<ImageDirectUploadResult>;
    image(imageId: string): ImageHandle;
    list(options?: ImageListOptions): Promise<ImageList>;
    upload(
        image: ArrayBuffer | ReadableStream<Uint8Array<ArrayBufferLike>>,
        options?: ImageUploadOptions,
    ): Promise<ImageMetadata>;
}

Index

Methods

createDirectUpload image list upload

Methods

createDirectUpload

createDirectUpload(
options?: ImageDirectUploadOptions,
): Promise<ImageDirectUploadResult>
Create a Direct Creator Upload link, letting an end user upload an image straight to Cloudflare without exposing an API token
Parameters
- Optionaloptions: ImageDirectUploadOptions
  Upload link configuration
Returns Promise<ImageDirectUploadResult>
The new image ID and the upload URL to hand to the end user

Throws
ImagesError if creation fails
- Defined in src/server/worker-configuration.d.ts:13922

image

image(imageId: string): ImageHandle
Get a handle for a hosted image
Parameters
- imageId: string
  The ID of the image (UUID or custom ID)
Returns ImageHandle
A handle for per-image operations
- Defined in src/server/worker-configuration.d.ts:13899

list

list(options?: ImageListOptions): Promise<ImageList>
List hosted images with pagination
Parameters
- Optionaloptions: ImageListOptions
  List configuration
Returns Promise<ImageList>
List of images with pagination info

Throws
ImagesError if list fails
- Defined in src/server/worker-configuration.d.ts:13914

upload

upload(
image: ArrayBuffer | ReadableStream<Uint8Array<ArrayBufferLike>>,
options?: ImageUploadOptions,
): Promise<ImageMetadata>
Upload a new hosted image
Parameters
- image: ArrayBuffer | ReadableStream<Uint8Array<ArrayBufferLike>>
  The image file to upload
- Optionaloptions: ImageUploadOptions
  Upload configuration
Returns Promise<ImageMetadata>
Metadata for the uploaded image

Throws
ImagesError if upload fails
- Defined in src/server/worker-configuration.d.ts:13907