todo - API reference

API reference › @evolu/common › Function › todo

function todo<T>(): T;

Defined in: packages/common/src/Function.ts:202

Development placeholder that always throws.

Use to sketch function bodies before implementing them. TypeScript infers the return type from context, so surrounding code still type-checks. Use an explicit generic when there is no return type annotation.

Example

// Type inferred from return type annotation
const fetchUser = (id: UserId): Result<User, FetchError> => todo();

expectTypeOf(fetchUser).returns.toEqualTypeOf<Result<User, FetchError>>();

// Explicit generic when no return type
const getConfig = () => todo<Config>();

expectTypeOf(getConfig).returns.toEqualTypeOf<Config>();