Registry / storage / payload-cloud-storage-cf-img-adapter

payload-cloud-storage-cf-img-adapter

JSON →
library3.0.2jsnpmunverified

Adapter for @payloadcms/plugin-cloud-storage (v3.20+) that enables direct image upload to Cloudflare Images. v3.0.2 provides TypeScript types, ESM/CJS support, and integrates with Payload CMS using webpack 5. Key differentiator: native Cloudflare Images optimization and transformation capabilities vs generic S3 adapters.

npm install payload-cloud-storage-cf-img-adapter
INSTALL
IMPORT
SIG · PAYLOAD-CLOUD-STOR
P
payload-cloud-storage-cf-img-adapter
storagejavascriptv3.0.2
harness data pending
Install & Compatibility
Where this runs

No compatibility data collected yet for this library.

Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

cfImageAdapter
import { cfImageAdapter } from 'payload-cloud-storage-cf-img-adapter'
const cfImageAdapter = require('payload-cloud-storage-cf-img-adapter')
ESM-only since v3; CommonJS require will fail.
default
import cfImageAdapter from 'payload-cloud-storage-cf-img-adapter'
import { cfImageAdapter } from 'payload-cloud-storage-cf-img-adapter'
Default export is the adapter function; named export cfImageAdapter is also available but deprecated.

Configures Payload CMS to use Cloudflare Images as storage adapter for the media collection.

import { buildConfig } from 'payload/config'; import { cloudStorage } from '@payloadcms/plugin-cloud-storage'; import cfImageAdapter from 'payload-cloud-storage-cf-img-adapter'; export default buildConfig({ plugins: [ cloudStorage({ collections: { media: { adapter: cfImageAdapter({ accountHash: process.env.CF_ACCOUNT_HASH ?? '', apiToken: process.env.CF_API_TOKEN ?? '', accountId: process.env.CF_ACCOUNT_ID ?? '', }), }, }, }), ], });
Debug
Known issues
breakingv3 drops CommonJS support: package is ESM-only. Projects using require() will break.
fix
Switch to ESM (import/export) or use dynamic import().
affects: >=3.0.0
deprecatedNamed export cfImageAdapter is deprecated in v3.0.0; use default export instead.
fix
Replace import { cfImageAdapter } with import cfImageAdapter.
affects: 3.0.0
gotchaAll three config options (accountHash, apiToken, accountId) are required at runtime. Missing one will cause a silent fail.
fix
Always set CF_ACCOUNT_HASH, CF_API_TOKEN, CF_ACCOUNT_ID environment variables.
affects: >=1.0.0
Errors
Common errors & fixes
Error [ERR_MODULE_NOT_FOUND]: Cannot find module 'payload-cloud-storage-cf-img-adapter'
Trying to require() an ESM-only package in CommonJS context.
fix
Use import instead of require, or add type: 'module' to package.json.
TypeError: cfImageAdapter is not a function
Using deprecated named export cfImageAdapter while expecting default export behavior.
fix
Change to import cfImageAdapter from 'payload-cloud-storage-cf-img-adapter'.
Upgrade
Version history
3.0.2latest on npm
Audit
Dependencies
payloadrequiredPeer dependency: requires Payload CMS v3.20+
@payloadcms/plugin-cloud-storagerequiredPeer dependency: required plugin for cloud storage integration
webpackrequiredPeer dependency: webpack 5 needed for bundling
Agent activity
16 hits · last 30 days
node
14
Amazon
1
OpenAI (training)
1
Resources
payload-cloud-storage-cf-img-adapter — npm install payload-cloud-storage-cf-img-adapter · libregistry