README.md

GunDB React hooks

This is a set of hooks that wrap around GunDB core functionality. API is subject to change, but will more or less remain similar.

Installing

Use pnpm, npm or yarn to install the dependencies:

$ npm i @altrx/gundb-react-hooks

Preact

If you need support for Preact you can import from @altrx/gundb-react-hooks/preact instead.

Hooks

• useGun
• useGunNamespace
• useGunKeyAuth
• useGunKeys
• useGunOnNodeUpdated
• useGunState
• useGunCollectionState

Full Example

To see a full example visit https://github.com/alterx/gun-react-todoapp

License

Licensed under MIT.