restate / v1.0.0

Сохраняйте, когда решите

Храните хранилище в IndexedDB или MMKV, загружайте его один раз при запуске, сохраняйте явно или автоматически и показывайте несохранённые правки.

На этой странице

Объявление сохраняемого хранилища Ожидание один раз при запуске Сохранение, отмена и сброс Показ несохранённых правок и хода сохранения Попробуйте Автоматическое сохранение Перед закрытием страницы Обработка ошибок хранилища

Объявление сохраняемого хранилища

Замените restate на persistedRestate и задайте key. Компоненты продолжают использовать тот же хук и тот же set.

Сохранённое значение восстанавливается автоматически после создания. Правка меняет память; ничего не записывается, пока вы не сохраните или не включите autoSave.

import { persistedRestate } from '@kkwaenggwari/restate';

export const useDraft = persistedRestate('', {
  key: 'article-draft',
  validate: (value) => typeof value === 'string',
});

Ожидание один раз при запуске

В клиентской точке входа импортируйте приложение и его хранилища, затем дождитесь restateManager.ready перед рендером. После этого компоненты могут сразу читать сохранённые значения.

Недоступное хранилище — например, при рендеринге на сервере или в браузере, который его блокирует, — не ошибка: такие хранилища работают в памяти. ready отклоняется, только когда записи нельзя прочитать, мигрировать или проверить.

import { createRoot } from 'react-dom/client';
import { restateManager } from '@kkwaenggwari/restate';
import App from './App';

async function start() {
  const root = createRoot(document.getElementById('root'));
  try {
    await restateManager.ready;
    root.render(<App />);
  } catch (error) {
    root.render(<p>Could not load saved data.</p>);
    console.error(error);
  }
}
start();

Сохранение, отмена и сброс

save записывает текущее значение, restore возвращает сохранённое, а resetAll очищает и память, и хранилище. Каждый возвращает Promise.

await useDraft.save(); // write the current value
await useDraft.restore(); // return to the saved value
await useDraft.resetAndClearStorage(); // initial value in memory, record removed

Показ несохранённых правок и хода сохранения

useStatus перерисовывается, когда меняется статус сохранения. dirty равно true, пока память отличается от последнего загруженного, сохранённого или восстановленного значения. operation называет текущую операцию с хранилищем.

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

Поля статуса

dirty      true | false
operation  "save" | "restore" | … | null
pending    number of unsettled operations
error      last storage error or null
available  false when storage cannot be used

Неудачное сохранение оставляет dirty равным true и заполняет error. Следующая успешная операция с хранилищем очищает error.

function SaveButton() {
  const { dirty, operation, error } = useDraft.useStatus();
  const saving = operation === 'save';

  return (
    <>
      <button disabled={!dirty || saving} onClick={() => useDraft.save().catch(() => {})}>
        {saving ? 'Saving…' : 'Save'}
      </button>
      {error != null && <p>Could not save your draft.</p>}
    </>
  );
}

Попробуйте

Печатайте, увеличьте задержку хранилища и сохраните. Повторите пример, чтобы увидеть восстановленный черновик.

КонтроллерНе входит в код примера. Значения попадают в пример как props.

Задержка хранилищаlatency

<Example
  latency={600}
/>

Подготовка примера…

Для живых примеров нужен JavaScript. Код ниже можно читать как есть.

App.jsx

import { useEffect } from 'react';
import { persistedRestate } from '@kkwaenggwari/restate';
import { settings, slowStorage } from './storage.js';
import './styles.css';

const useDraft = persistedRestate('', { key: 'playground-draft', storage: slowStorage });

export default function Example({ latency = 600 }) {
  useEffect(() => {
    settings.latency = latency;
  }, [latency]);

  const text = useDraft();
  const { dirty, operation, pending, lastSavedAt } = useDraft.useStatus();
  // A failed save keeps dirty and records status.error.
  const save = () => useDraft.save().catch(() => {});
  const revert = () => useDraft.restore().catch(() => {});

  return (
    <main>
      <label>
        Черновик
        <textarea value={text} onChange={(event) => useDraft.set(event.target.value)} />
      </label>
      <div className="actions">
        <button disabled={!dirty} onClick={save}>
          Сохранить
        </button>
        <button disabled={!dirty} onClick={revert}>
          Отменить правки
        </button>
      </div>
      <dl className="status">
        <dt>dirty</dt>
        <dd className={dirty ? 'warn' : 'ok'}>{dirty ? 'несохранённые правки' : 'сохранено'}</dd>
        <dt>operation</dt>
        <dd>{operation ?? 'нет'}</dd>
        <dt>pending</dt>
        <dd>{pending}</dd>
        <dt>lastSavedAt</dt>
        <dd>{lastSavedAt ? new Date(lastSavedAt).toLocaleTimeString() : 'ещё нет'}</dd>
      </dl>
    </main>
  );
}

storage.js

import { createIndexedDBStorage } from '@kkwaenggwari/restate';

// IndexedDB with an adjustable delay, to watch operations in progress.
const indexedDB = createIndexedDBStorage();
export const settings = { latency: 0 };
const wait = () => new Promise((resolve) => setTimeout(resolve, settings.latency));

export const slowStorage = {
  async getItem(key) {
    await wait();
    return indexedDB.getItem(key);
  },
  async setItem(key, value) {
    await wait();
    return indexedDB.setItem(key, value);
  },
  async removeItem(key) {
    await wait();
    return indexedDB.removeItem(key);
  },
};

Автоматическое сохранение

Для настроек и черновиков, которые всегда должны сохраняться, включите его один раз. autoSave: true сохраняет после каждого изменения; { delayMs } ждёт, пока правки прекратятся.

Серия правок превращается в одну запись, а возврат к сохранённому значению ничего не пишет. Ошибки появляются в status().error. Область компонента записывает ожидающую правку при размонтировании.

export const useTheme = persistedRestate('light', { key: 'theme', autoSave: true });

export const useDraft = persistedRestate('', {
  key: 'article-draft',
  autoSave: { delayMs: 500 },
});

Перед закрытием страницы

Читайте то же состояние вне React. Предупреждайте перед уходом, если есть несохранённые правки, или сохраняйте всё, когда страница скрывается.

window.addEventListener('beforeunload', (event) => {
  if (useDraft.status().dirty) event.preventDefault();
});

window.addEventListener('pagehide', () => {
  restateManager.saveAll();
});

Обработка ошибок хранилища

Ошибки хранилища отклоняют Promise операции. У каждой ошибки restate есть code, а у сохраняемых хранилищ — ещё и key записи.

try {
  await useDraft.save();
} catch (error) {
  if (error.code === 'STORAGE_UNAVAILABLE') showNotice('Saving is off in this browser.');
  else if (error.code === 'STORAGE_VALUE_TOO_LARGE') showNotice('This draft is too large.');
  else showNotice(`Could not save "${error.key ?? 'draft'}".`);
}

Написано для API restate 1.0