Async-Xtate


A lightweight, type-safe library for managing async state in TypeScript applications.

Features

- 🚀 Type-safe async state management
- 📦 Zero dependencies
- 🎯 Simple and intuitive API
- 🔄 Support for all async states (initial, loading, success, error, refetch)
- 🛠️ Built with TypeScript

Installation

``bash
npm install async-xtate


or

yarn add async-xtate

or

pnpm add async-xtate

or

bun add async-xtate
`

Usage

`typescript
import {
makeAsyncSuccessState,
makeAsyncErrorState,
makeAsyncLoadingState,
makeRefetchState,
makeInitialState,
type AsyncState
} from 'async-xtate';

// Define your data and error types
type UserData = { name: string; email: string };
type UserError = string;

// Create different states
const successState = makeAsyncSuccessState({
name: 'John Doe',
email: 'john@example.com'
});

const errorState = makeAsyncErrorState(
'Failed to fetch user',
{ name: 'John Doe', email: 'john@example.com' }
);

const loadingState = makeAsyncLoadingState();

const refetchState = makeRefetchState(
{ name: 'John Doe', email: 'john@example.com' }
);

const initialState = makeInitialState();
`

API Reference

$3

- AsyncSuccessState: Represents a successful async operation
- AsyncErrorState: Represents a failed async operation
- AsyncLoadingState: Represents a loading state
- AsyncRefetchState: Represents a refetching state
- AsyncInitialState: Represents the initial state
- AsyncState: Union type of all possible states

$3

- makeAsyncSuccessState(data: Data): Creates a success state
- makeAsyncErrorState(error: Err, data?: Data): Creates an error state
- makeAsyncLoadingState(data?: Data, error?: Err): Creates a loading state
- makeRefetchState(data?: Data, error?: Err): Creates a refetch state
- makeInitialState(data?: Data, error?: Err): Creates an initial state

Type Safety

The library is fully type-safe, providing TypeScript with all the information it needs to ensure type correctness:

`typescript
const state: AsyncState = makeAsyncSuccessState({
name: 'John Doe',
email: 'john@example.com'
});

// TypeScript knows the exact shape of the state
if (state.status === 'success') {
console.log(state.data.name); // ✅ TypeScript knows this is safe
}
``

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

License

MIT © Roberto Ríos