Эффектор предоставляет несколько утилитарных типов для облегчения получения типа значения юнита.
UnitValue<Type>
Получение типа значения переданного Unit.
Пример
import { createEffect, createStore, createDomain, createEvent, fork, UnitValue } from "effector";
const event = createEvent<{ id: string; name?: string } | { id: string }>();
const $store = createStore([false, true]);
const effect = createEffect<{ token: string }, any, string>(() => {});
const domain = createDomain();
const scope = fork();
type UnitEventType = UnitValue<typeof event>;
// {id: string; name?: string | undefined} | {id: string}
type UnitStoreType = UnitValue<typeof store>;
// boolean[]
type UnitEffectType = UnitValue<typeof effect>;
// {token: string}
type UnitDomainType = UnitValue<typeof domain>;
// any
type UnitScopeType = UnitValue<typeof scope>;
// any
StoreValue<Type>
Получение типа значения Store.
Пример
import { createStore, StoreValue } from "effector";
const $store = createStore(true);
type StoreValueType = StoreValue<typeof $store>;
// boolean
EventPayload<Type>
Получение типа значения переданного в Event.
Пример
import { createEvent, EventPayload } from "effector";
const event = createEvent<{ id: string }>();
type EventPayloadType = EventPayload<typeof event>;
// {id: string}
EffectParams<Type>
Получение типа параметров Effect.
Пример
import { createEffect, EffectParams } from "effector";
const fx = createEffect<
{ id: string },
{ name: string; isAdmin: boolean },
{ statusText: string; status: number }
>(() => ({ name: "Alice", isAdmin: false }));
type EffectParamsType = EffectParams<typeof fx>;
// {id: string}
EffectResult<Type>
Получение типа результата Effect.
Пример
import { createEffect, EffectResult } from "effector";
const fx = createEffect<
{ id: string },
{ name: string; isAdmin: boolean },
{ statusText: string; status: number }
>(() => ({ name: "Alice", isAdmin: false }));
type EffectResultType = EffectResult<typeof fx>;
// {name: string; isAdmin: boolean}
EffectError<Type>
Получение типа ошибки Effect.
Пример
import { createEffect, EffectError } from "effector";
const fx = createEffect<
{ id: string },
{ name: string; isAdmin: boolean },
{ statusText: string; status: number }
>(() => ({ name: "Alice", isAdmin: false }));
type EffectErrorType = EffectError<typeof fx>;
// {statusText: string; status: number}
Перевод поддерживается сообществом
Документация на английском языке - самая актуальная, поскольку её пишет и обновляет команда effector. Перевод документации на другие языки осуществляется сообществом по мере наличия сил и желания.
Помните, что переведенные статьи могут быть неактуальными, поэтому для получения наиболее точной и актуальной информации рекомендуем использовать оригинальную англоязычную версию документации.