Плагин передаёт скоуп всему приложению: хуки читают из него сторы и вызывают в нём события. Нужен для SSR.

Плагины

EffectorScopePlugin({ scope, scopeName, forceScope, live })

Формула

EffectorScopePlugin(options: EffectorScopePluginOptions): Plugin;
app.use(EffectorScopePlugin, options: EffectorScopePluginOptions): App;

Аргументы

1. scope Scope, созданный через fork
2. scopeName? своё имя скоупа (по умолчанию root), устаревший строковый ключ инъекции
3. forceScope? бросить ошибку вместо перехода в глобальный режим, когда хук этого приложения не нашёл скоуп (по умолчанию false)
4. live? подписываются ли хуки на скоуп: false заставляет их читать скоуп при обращении без подписки, как при серверном рендере, true заставляет подписываться всегда (по умолчанию false внутри renderToString, true в остальных случаях)

Плагин передаёт скоуп под ключом инъекции EffectorScopeKey и, для обратной совместимости, под строкой scopeName.

Импорт

Во Vue 3 импортируйте плагин из effector-vue/composition, рядом с остальными методами Composition API:

import { EffectorScopePlugin, EffectorScopeKey } from "effector-vue/composition";

Из effector-vue/composition плагин экспортируется с effector-vue 23.2.0. Корневая точка входа effector-vue тоже экспортирует плагин и продолжит это делать ради обратной совместимости. Это точка входа API для Vue 2 (VueEffector, createComponent), поэтому приложение на Vue 3, которое импортирует из неё, тянет код, который никогда не выполняет.

Примеры

Базовый пример

import { createSSRApp } from "vue";
import { EffectorScopePlugin } from "effector-vue/composition";
import { fork } from "effector";

const app = createSSRApp(AppComponent);
const scope = fork();

app.use(
  EffectorScopePlugin({
    scope,
    scopeName: "app-scope-name",
  }),
);

Опции в app.use

Обе формы устанавливают плагин:

app.use(EffectorScopePlugin({ scope }));
app.use(EffectorScopePlugin, { scope });

Обязательный скоуп

С forceScope хук, который не нашёл скоуп, бросает ошибку, а не читает глобальные сторы:

app.use(EffectorScopePlugin({ scope, forceScope: true }));

Опция читается через контекст инъекции, поэтому действует на вызовы, которые видят приложение: setup, app.runWithContext и всё, что вызвано до первого await в асинхронном setup. Вызов, потерявший контекст, не видит ни скоупа, ни опции: передайте ему { forceScope: true } напрямую.

Как выбирается скоуп

Куда передаются опции скоупа, зависит от хука:

В любой форме скоуп ищется в таком порядке:

1. опция scope вызова;
2. значение под ключом EffectorScopeKey, если у вызова есть контекст инъекции;
3. устаревший строковый ключ, если доступен экземпляр компонента;
4. глобальный режим, если не включён forceScope.

Строковый ключ читается, только когда под EffectorScopeKey ничего не передано. С установленным плагином поддерево переопределяет скоуп через provide(EffectorScopeKey, scope); значение, переданное под строкой scopeName, этого больше не делает.

Ключ создан через Symbol.for, поэтому скоуп, переданный другой копией пакета, тоже находится. Плагин для этого не нужен, достаточно передать скоуп вручную:

import { provide } from "vue";
import { EffectorScopeKey } from "effector-vue/composition";

provide(EffectorScopeKey, scope);

Связанные API

• useProvidedScope возвращает найденный скоуп напрямую.