@web3nl/vite-plugin-canister-dapp - v0.4.3
    Preparing search index...

    Interface CanisterDappEnvironmentPluginConfig

    Plugin configuration interface for enabling/disabling features

    interface CanisterDappEnvironmentPluginConfig {
        environment?: {
            development?: CanisterDappEnvironmentConfig;
            production?: CanisterDappEnvironmentConfig;
        };
        serverProxies?: {
            api?: boolean;
            canisterDashboard?: boolean;
            iiAlternativeOrigins?: boolean;
        };
        viteDevCanisterId?: string;
    }
    Index

    Properties

    environment? serverProxies? viteDevCanisterId?

    Properties

    environment?: {
        development?: CanisterDappEnvironmentConfig;
        production?: CanisterDappEnvironmentConfig;
    }

    Environment configurations for development and production. Both are optional and will use sensible defaults if not provided.

    Type Declaration

    serverProxies?: {
        api?: boolean;
        canisterDashboard?: boolean;
        iiAlternativeOrigins?: boolean;
    }

    Server proxy to IC configuration (default: all enabled, only applies in Vite dev server)

    Type Declaration

    • Optionalapi?: boolean

      Enable /api proxy (default: true)

    • OptionalcanisterDashboard?: boolean

      Enable /canister-dashboard proxy (default: true)

    • OptionaliiAlternativeOrigins?: boolean

      Enable /.well-known/ii-alternative-origins proxy (default: true)

    viteDevCanisterId?: string

    Canister ID for Vite dev server environments. This is only needed when running in a Vite dev server where the canister ID cannot be inferred from the URL (e.g., http://localhost:5173). In production and local dfx environments, the canister ID is inferred from the URL. This is also used for proxy rewrites in the Vite dev server.

    Settings

    Member Visibility

    On This Page

    Properties