status

import { status } from 'patronum';
// or
import { status } from 'patronum/status';

Motivation

This method returns current status of effect as store with string enumeration. It is useful to show correct state of process in UI.

Formulae

$status = status(effect);
$status = status({ effect, defaultValue });

• When status is run, set defaultValue value to $status
• When effect is called, set pending status.
• When effect is succeeded, set done status.
• When effect is failed, set fail status.

Note

Shorthand status(effect) is available since patronum 2.1.0 Use status({ effect }) with patronum < 2.1.0

Arguments

1. effect (Effect<P, R>) — any effect, that you need to watch status
2. defaultValue ('initial' | 'pending' | 'done' | 'fail') optional — when $status initializes, set initial value for it. By default value is "initial"

Returns

• $status (Store<'initial' | 'pending' | 'done' | 'fail'>) — Store that saves current state of the effects

Note: use can manually reset status, just use $status.reset(event)

Example

Successful effect call changing status to “done”

import { createEvent, createEffect } from 'effector';
import { status } from 'patronum/status';

const effect = createEffect(() => Promise.resolve(null));
const $status = status({ effect });

$status.watch((value) => console.log(`status: ${value}`));
// => status: "initial"

effect();
// => status: "pending"
// => status: "done"

Initial status

import { createEvent, createEffect } from 'effector';
import { status } from 'patronum/status';

const effect = createEffect(() => Promise.resolve(null));
const $status = status({ effect, defaultValue: 'pending' });

$status.watch((value) => console.log(`status: ${value}`));
// => status: "pending"

effect();
// Nothing, because $status is already pending
// => status: "done"

Clear (reset) status

import { createEvent, createEffect } from 'effector';
import { status } from 'patronum/status';

const reset = createEvent();
const effect = createEffect(() => new Promise((resolve) => setTimeout(resolve, 100)));

const $status = status({ effect });
$status.reset(reset);

$status.watch((value) => console.log(`status: ${value}`));
// => status: "initial"

effect();
// => status: "pending"
// => status: "done"

reset();
// => status: "initial"