Interface SSRExecutorManagerOptions

Options provided to the SSRExecutorManager constructor.

interface SSRExecutorManagerOptions {
    devtools?: boolean;
    executorFilter?: ((executor) => boolean);
    keySerializer?: ((key) => any);
    nonce?: string;
    plugins?: (undefined | null | ExecutorPlugin)[];
    stateStringifier?: ((state) => string);
}

Hierarchy (view full)

Properties

devtools? executorFilter? keySerializer? nonce? plugins? stateStringifier?

Properties

Optional devtools

devtools?: boolean

If true then executors are registered in the devtools extension.

Default

true

Optional executorFilter

executorFilter?: ((executor) => boolean)

Filters executors that must be hydrated on the client with the state that was accumulated during SSR.

By default, only executors that were fulfilled during SSR are hydrated on the client.

Type declaration

    • (executor): boolean

    • Parameters

      • executor: Executor<any>

        The executor to check.

      Returns boolean

Returns

true if the executor must be hydrated on the client, or false otherwise.

Optional keySerializer

keySerializer?: ((key) => any)

Serializes executor keys.

The serialized key form can be anything. If you want to use object identities as executor keys, provide an identity function as a serializer.

Type declaration

    • (key): any

    • Parameters

      • key: any

        The key to serialize.

      Returns any

Default

JSON.stringify

Optional nonce

nonce?: string

A nonce string to allow scripts for script-src Content-Security-Policy.

Optional plugins

plugins?: (undefined | null | ExecutorPlugin)[]

Plugins that are applied to all executors.

Optional stateStringifier

stateStringifier?: ((state) => string)

Stringifies an executor state before it is sent to the client.

Type declaration

    • (state): string

    • Parameters

      Returns string

Default

JSON.stringify

Settings

Member Visibility

Theme

On This Page

devtoolsexecutorFilterkeySerializernoncepluginsstateStringifier