import { hydrate } from "effector";

Сопутствующий метод для serialize. Гидрирует предоставленные значения в соответствующие сторы в рамках предоставленного домена или скоупа. Основная цель — гидрация состояния приложения на стороне клиента после SSR (Server-Side Rendering).

Методы

hydrate(domainOrScope, { values })

Важно

Необходимо убедиться, что стор создан заранее, иначе гидрация может завершиться неудачей. Это может произойти, если вы разделяете скрипты инициализации/гидрации сторов от их создания.

Формула

hydrate(domainOrScope: Domain | Scope, { values: Map<Store<any>, any> | {[sid: string]: any} }): void

Аргументы (methods-hydrate-domainOrScope-values-arguments)

  1. domainOrScope: домен или область видимости, который будет заполнен предоставленными values.
  2. values: отображение из sid (идентификаторов сторов) в значения сторов или Map, где ключи — это объекты сторов, а значения содержат начальное значение стора.

Возвращает

void

Примеры

Заполнение стора предопределенным значением:

import { createStore, createDomain, fork, serialize, hydrate } from "effector";

const domain = createDomain();
const $store = domain.createStore(0);

hydrate(domain, {
  values: {
    [$store.sid]: 42,
  },
});

console.log($store.getState()); // 42

Запустить пример

Перевод поддерживается сообществом

Документация на английском языке - самая актуальная, поскольку её пишет и обновляет команда effector. Перевод документации на другие языки осуществляется сообществом по мере наличия сил и желания.

Помните, что переведенные статьи могут быть неактуальными, поэтому для получения наиболее точной и актуальной информации рекомендуем использовать оригинальную англоязычную версию документации.

Соавторы
Commits