Zustand
Этот плагин позволяет захватывать мутации и состояние Zustand и просматривать их позже при воспроизведении записей сессий. Это очень полезно для понимания и устранения проблем.
Установка
Section titled Установкаnpm i @openreplay/tracker-zustand
Использование
Section titled ИспользованиеИнициализируйте пакет @openreplay/tracker как обычно и загрузите в него плагин. Вызовите плагин, чтобы задать имя хранилища; это вернёт именованный экземпляр трекера хранилища, который вы можете вызвать, передав ваш образец хранилища в качестве аргумента, чтобы включить отслеживание этого хранилища.
Если ваш сайт является одностраничным приложением (SPA)
Section titled Если ваш сайт является одностраничным приложением (SPA)import Tracker from '@openreplay/tracker';
import trackerZustand from '@openreplay/tracker-zustand';
Если ваше веб-приложение рендерится на стороне сервера (SSR)
Section titled Если ваше веб-приложение рендерится на стороне сервера (SSR)import Tracker from '@openreplay/tracker/cjs';
import trackerZustand from '@openreplay/tracker-zustand/cjs';
Отслеживание хранилища Zustand
Section titled Отслеживание хранилища Zustandimport create from "zustand";
import Tracker from '@openreplay/tracker';
import trackerZustand, { StateLogger } from '@openreplay/tracker-zustand';
const tracker = new Tracker({
projectKey: YOUR_PROJECT_KEY,
});
// as per https://docs.pmnd.rs/zustand/guides/typescript#middleware-that-doesn't-change-the-store-type
// cast type to new one
// but this seems to not be required and everything is working as is
const zustandPlugin = tracker.use(trackerZustand()) as unknown as StateLogger
const useBearStore = create(
zustandPlugin((set: any) => ({
bears: 0,
increasePopulation: () => set((state: any) => ({ bears: state.bears + 1 })),
removeAllBears: () => set({ bears: 0 }),
}),
// store name is optional
// and is randomly generated if undefined
'bear_store'
)
)
Опции
Section titled ОпцииВы можете настроить поведение плагина с помощью опций для очистки ваших данных. Они аналогичны опциям стандартного плагина createLogger.
trackerZustand({
filter (mutation, state) {
// returns `true` if a mutation should be logged
// `mutation` is a `{ type, payload }`
return mutation.type !== "aBlacklistedMutation";
},
transformer (state) {
// transform the state before logging it.
// for example return only a specific sub-tree
return state.subTree;
},
mutationTransformer (mutation) {
// mutations are logged in the format of `{ type, payload }`
// we can format it any way we want.
return mutation.type;
},
})
Остались вопросы?
Section titled Остались вопросы?Возникли трудности с настройкой этого плагина? Присоединяйтесь к нашему Slack или загляните на наш Форум и получите помощь от нашего сообщества.