vapor-chamber API reference - v1.16.0
    Preparing search index...

    Type Alias SSRPlugin

    type SSRPlugin = {
        plugin: Plugin;
        dehydrate(): DehydratedCommand[];
        clear(): void;
        size(): number;
        dropped(): number;
    }
    Index
    • Clear recorded commands. Call in finally block after each SSR request.

      Returns void

    • Number of recorded commands.

      Returns number

    • How many commands were dropped at the maxCommands cap. Non-zero means the client will rehydrate PARTIAL state — server/client divergence. Check it after dehydrate() rather than trusting the render silently: a cap that reads as "recorded everything" when it didn't is the failure mode this accessor exists to make visible.

      Returns number

    plugin: Plugin

    Sync plugin — install on the server bus via bus.use(ssr.plugin).