ToFlowGeneratorFunction


The toFlowGeneratorFunction is a utility function that converts a promise-returning function into a generator-returning function. It is designed to enable the usage of type-safe yield statements inside MobX flow wrapper.

Parameters

- fn: The promise-returning function to be converted into a generator-returning function.

Examples

``typescript
import { flow } from 'mobx';
import { toFlowGeneratorFunction, type FlowGenerator } from 'to-flow-generator-function';

interface UserData {
id: number;
name: string;
age: number;
}

const fetchUserName = (id: number): Promise => Promise.resolve('John');
const fetchUserAge = (id: number): Promise => Promise.resolve(25);

function* fetchUserData(id: number): FlowGenerator {
const name = yield* toFlowGeneratorFunction(fetchUserName)(id);
// Here, name has the type string.
const age = yield* toFlowGeneratorFunction(fetchUserAge)(id);
// Here, age has the type number.
return {
id,
name,
age,
};
}

const userId = 3;
const userData = await flow(fetchUserData)(userId);
// Here, useData has the type UserData.
``

More examples in toFlowGeneratorFunction.spec.ts

Alternative solutions