Class CFImages

Main class for interacting with Cloudflare Images API CFImages

Constructors

Methods

Constructors

  • Creates a new CFImages instance

    Parameters

    Returns CFImages

    If running in browser when preventBrowserUsage is true

    If required credentials are missing

Methods

  • Uploads an image to Cloudflare Images

    Parameters

    Returns Promise<ImageOperationResult>

    Promise resolving to the upload result

    If the upload fails

    const cfImages = new CFImages({
    token: 'your-token',
    accountId: 'your-account-id'
    imageAccountHash: 'your-image-account-hash'
    });

    // Upload from URL
    const result = await cfImages.uploadImage({
    url: 'https://example.com/image.jpg',
    metadata: { key: 'value' },
    requireSignedURLs: false
    });

    // Upload from File
    const file = new File(['...'], 'image.jpg');
    const result = await cfImages.uploadImage({
    file,
    metadata: { key: 'value' },
    requireSignedURLs: false
    });