Skip to content

I-am-abdulazeez/stunk-docs

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

📖 Stunk Documentation

Welcome to the official Stunk documentation! 🚀 Stunk is a lightweight, framework-agnostic state management library built with TypeScript, offering powerful reactivity, selectors, computed values, async handling, and middleware support.

📜 What’s Inside?

This documentation covers everything you need to know about using Stunk effectively, including:

  • Core API – Learn about get, set, subscribe, batch, reset, and more.
  • Advanced Features – Explore derive, selectors, computed properties.
  • Async Support – Work with asyncChunk and combineAsyncChunk.
  • Middleware – Extend Stunk with withHistory, withPersistence, and custom middleware.
  • Best Practices – Optimize performance and structure state management effectively.

You can also check our example repo: Stunk Examples

🔗 Getting Started

Head over to the full documentation: Stunk Docs

For installation and a quick setup guide:

npm install stunk
# or
yarn add stunk
pnpm add stunk

💡 Contributing

Stunk is open-source! Contributions, issues, and feature requests are welcome. Check out the contribution guide to get started.

🌎 Community & Support

  • Join the discussion on GitHub Issues
  • Follow updates on Twitter | X

Happy coding with Stunk! 🎉

About

Official Documentation of the Stunk library.

Topics

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •