Setu-TS
    Preparing search index...

    Interface CloudflarePluginOptions

    Options for CloudflarePlugin.

    import { env, waitUntil } from 'cloudflare:workers';

    app.register(CloudflarePlugin({ env, waitUntil }));

    app.register(CloudflarePlugin({
      env,
      waitUntil,
      cache: { binding: 'CACHE_KV', prefix: 'cache:' },
      storage: { binding: 'UPLOADS' },
      requireBindings: ['CACHE_KV', 'UPLOADS', 'SESSIONS'],
    }));

    0.2.0

    interface CloudflarePluginOptions {
        cache?: KvCacheOptions;
        durableObject?: DurableObjectArm;
        env: CloudflareWorkerEnv;
        messaging?: WorkersMessagingArm;
        queue?: WorkersQueueArm;
        requireBindings?: readonly string[];
        storage?: R2StorageArm;
        waitUntil?: WaitUntilHost;
    }
    Index
    cache? durableObject? env messaging? queue? requireBindings? storage? waitUntil?
    cache?: KvCacheOptions

    Serve CAPABILITIES.CACHE from a KV namespace. Omitted registers nothing.

    durableObject?: DurableObjectArm

    Serve CAPABILITIES.REALTIME_BACKPLANE from a Durable Object namespace. Omitted registers nothing.

    env: CloudflareWorkerEnv

    The Worker's env, from import { env } from 'cloudflare:workers'.

    Passed in rather than imported by this package: cloudflare:workers is unresolvable outside a Worker toolchain, so importing it here would break type-checking on every other runtime.

    messaging?: WorkersMessagingArm

    Serve CAPABILITIES.MESSAGING from a Queues producer binding. Omitted registers nothing.

    queue?: WorkersQueueArm

    Serve CAPABILITIES.QUEUE from a Queues producer binding. Omitted registers nothing.

    requireBindings?: readonly string[]

    Bindings that must be present. register() throws naming every absent one, so a missing wrangler.toml stanza fails at startup instead of on the first request that needs it.

    storage?: R2StorageArm

    Serve CAPABILITIES.STORAGE from an R2 bucket. Omitted registers nothing.

    waitUntil?: WaitUntilHost

    The platform's background-work sink, from import { waitUntil } from 'cloudflare:workers' (available from compatibility date 2025-08-08).

    Omitting it leaves bindings.waitUntil() running the promise without extending the invocation — correct off Cloudflare Workers, and a silent truncation risk on it, so pass it whenever deploying to Workers.

    Settings
    Member Visibility

    On This Page
    Properties