vite-plugin-cloudflare-functions/dist/index.d.mts

Make Cloudflare Pages Functions works with Vite friendly

import { Plugin } from 'vite';

interface UserConfig {
    /**
     * Cloudflare Functions root directory
     *
     * This directory is relative to the Vite root
     *
     * @default './functions'
     */
    root?: string;
    /**
     * Copy the functions directory to outDir
     *
     * When it is undefined, plugin will not copy the directory
     *
     * This directory is relative to the Vite root
     *
     * @default false
     */
    outDir?: string | boolean;
    /**
     * Filepath to generate corresponding .d.ts file
     *
     * @default './cloudflare.d.ts'
     */
    dts?: string | boolean;
    wrangler?: {
        /**
         * Wrangler dev server port
         *
         * @default 8788
         */
        port?: number;
        /**
         * Enable wrangler log
         *
         * @default false
         */
        log?: boolean;
        /**
         * Bind variable/secret
         */
        binding?: Record<string, string>;
        /**
         * Bind KV namespace
         */
        kv?: string | string[];
        /**
         * Bind D1 database
         */
        d1?: string | string[];
        /**
         * Bind Durable Object
         */
        do?: Record<string, string | {
            class: string;
            script: string;
        }>;
        /**
         * Bind R2 bucket
         */
        r2?: string | string[];
        /**
         * Bind Workers AI
         */
        ai?: string | string[];
        /**
         * Specify directory to use for local persistence
         *
         * @default <fucntions_dir>/.wrangler/state
         */
        persistTo?: boolean | string;
        /**
         * Determines which version of the Workers runtime is used.
         */
        compatibilityDate?: string;
    };
}

declare function CloudflarePagesFunctions(userConfig?: UserConfig): Plugin;

export { CloudflarePagesFunctions as default };