{"_id":"@athrok/react-native-mmkv","name":"@athrok/react-native-mmkv","dist-tags":{"latest":"0.0.1-alpha"},"versions":{"0.0.1-alpha":{"name":"@athrok/react-native-mmkv","version":"0.0.1-alpha","description":"React Native MMKV persistence wrapper for Athrok state management library.","main":"index.js","module":"index.mjs","types":"index.d.ts","homepage":"https://github.com/alok-shete/athrok-persist/react-native-mmkv#readme","publishConfig":{"access":"public"},"bugs":{"url":"https://github.com/alok-shete/athrok-persist/issues"},"repository":{"type":"git","url":"git+https://github.com/alok-shete/athrok-persist.git"},"keywords":["react-native","async-storage","react-native-mmkv","persistence","wrapper","state-management","Athrok"],"author":{"name":"Alok Shete"},"license":"MIT","peerDependencies":{"react":"*","react-native-mmkv":"*","athrok":"*"},"contributors":[{"name":"Alok Shete","email":"shetealok@gmail.com"}],"_id":"@athrok/react-native-mmkv@0.0.1-alpha","gitHead":"78a55e5a432576868e9cc1a98d50906eafaba6a9","_nodeVersion":"18.19.0","_npmVersion":"10.2.3","dist":{"integrity":"sha512-qMet3kccMVUXl0Iydpc8VZBNR5dCn+h6TJxBUdRVIgHyvWqnWCXtGYsKFGT5atncSMpol43NTTAjP2hJ/jgPHQ==","shasum":"5f50bd0b52477abe14a4baad5756e83f5855e000","tarball":"https://registry.npmjs.org/@athrok/react-native-mmkv/-/react-native-mmkv-0.0.1-alpha.tgz","fileCount":7,"unpackedSize":10838,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBsDszC6UNVcTf4jNtdXu0Me4IFNdtIH8CQsNjsPuCvyAiEAhPyLXpPfwAlXXSvMwgWUUqcIUStal5rtZmKeiaxFnZc="}]},"_npmUser":{"name":"shetealok","email":"shetealok@gmail.com"},"directories":{},"maintainers":[{"name":"shetealok","email":"shetealok@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/react-native-mmkv_0.0.1-alpha_1715513265780_0.15282364399526216"},"_hasShrinkwrap":false}},"time":{"created":"2024-05-12T11:27:45.684Z","0.0.1-alpha":"2024-05-12T11:27:45.927Z","modified":"2024-05-12T11:27:46.214Z"},"maintainers":[{"name":"shetealok","email":"shetealok@gmail.com"}],"description":"React Native MMKV persistence wrapper for Athrok state management library.","homepage":"https://github.com/alok-shete/athrok-persist/react-native-mmkv#readme","keywords":["react-native","async-storage","react-native-mmkv","persistence","wrapper","state-management","Athrok"],"repository":{"type":"git","url":"git+https://github.com/alok-shete/athrok-persist.git"},"contributors":[{"name":"Alok Shete","email":"shetealok@gmail.com"}],"author":{"name":"Alok Shete"},"bugs":{"url":"https://github.com/alok-shete/athrok-persist/issues"},"license":"MIT","readme":"# @athrok/react-native-mmkv\n\nReact Native MMKV Persistence Wrapper for Athrok State Management Library\n\n## Introduction\n\n`@athrok/react-native-mmkv` is a utility package that provides seamless integration between React Native's MMKV and Athrok state management library. This package offers a convenient way to persist application state managed by Athrok using MMKV, a fast key-value storage library for React Native.\n\n## Features\n\n- Adapts MMKV storage methods to conform to Athrok's state persistence requirements.\n- Allows easy integration of MMKV with Athrok's StorageManager for managing application state persistence.\n- Provides a simple and straightforward API for asynchronous storage operations.\n\n## Installation\n\nYou can install `@athrok/react-native-mmkv` via npm or yarn:\n\n```bash\nnpm install @athrok/react-native-mmkv\n```\n\nor\n\n```bash\nyarn add @athrok/react-native-mmkv\n```\n\n**Peer Dependencies**: Make sure you have `athrok` installed as a peer dependency.\n\n```bash\nnpm install athrok\n```\n\nor\n\n```bash\nyarn add athrok\n```\n\n## Usage\n\nTo use `@athrok/react-native-mmkv`, follow these steps:\n\n1. Import the necessary modules:\n\n```javascript\nimport React from \"react\";\nimport { PersistenceProvider } from \"@athrok/react-native-mmkv\";\n```\n\n2. Wrap your application's components with `PersistenceProvider`:\n\n```javascript\nexport default function App() {\n  return (\n    <PersistenceProvider>\n      {\n        // Place your application's child components and data here\n      }\n    </PersistenceProvider>\n  );\n}\n```\n\nIn this example, the `PersistenceProvider` component ensures that Athrok's MMKV persistence is initialized and ready for use throughout the application. You can place your application's child components and data inside the `PersistenceProvider` component to manage the persistence of the application state across app sessions seamlessly.\n\n## Contributing\n\nContributions to `@athrok/react-native-mmkv` are welcome! Feel free to submit bug reports, feature requests, or pull requests on [GitHub](https://github.com/alok-shete/athrok-persist).\n\n## License\n\nThis project is licensed under the [MIT License](https://github.com/alok-shete/athrok-persist/blob/main/LICENSE).\n","readmeFilename":"README.md"}