https://github.com/cinaaaa/pleex
⚛️ Turning Async Storage to Schematic based
https://github.com/cinaaaa/pleex
async-storage pleex react-native react-native-async-storage react-native-pleex schematics
Last synced: 5 months ago
JSON representation
⚛️ Turning Async Storage to Schematic based
- Host: GitHub
- URL: https://github.com/cinaaaa/pleex
- Owner: cinaaaa
- License: mit
- Created: 2020-04-29T10:37:45.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2023-01-27T04:41:09.000Z (over 2 years ago)
- Last Synced: 2025-02-06T19:57:50.743Z (5 months ago)
- Topics: async-storage, pleex, react-native, react-native-async-storage, react-native-pleex, schematics
- Language: JavaScript
- Homepage: https://pleex.gitbook.io/docs
- Size: 407 KB
- Stars: 4
- Watchers: 1
- Forks: 2
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
README
Pleex
💣 " Schematic " ➕ " Storage " 💣 for ⚛️ react native
Built with ❤ Sina Farhadi
## Get Started
### Installation
install pleex with npm or yarn
```bash
npm i pleex
```
or
```bash
yarn add pleex
```
also pleex don't need any extra configuration or installation with gradle or pods
### Want to see example? see youtube tutorial
[](https://www.youtube.com/watch?v=7bTX-mWmktw)
### Example Usage
Full example and list of api's can be find in [pleex documents](https://pleex.gitbook.io/docs)
this is example of creating schemas with pleex
```jsx
import {Pleex} from 'pleex';
const my_collection = Pleex.collection('test');
const my_schema = Pleex.schema({
name: String,
age: Number,
});
my_collection.insert(
{
name: 'Jack',
age: 12,
},
my_schema,
(success) => // Success,
(error) => console.error(error)
);
```
### Tests
you can test source code by
```bash
npm test
```
### This package helps you in:
- #### Having simple storage
- #### Create Schema and use them
- #### Type cheking for schemas
- #### Async workflow
- #### Integrated with async storage
- #### Save and use Json objects
- #### Built in searching api
### 🙋♂️ Contributing
Find issues or want to add features? see contributing [guide](https://pleex.gitbook.io/docs/contributing/how-to-contribute)
### Current api's:
- #### Collection
- #### Schema
- #### Insert
- #### removeItem
- #### removeItems
- #### getItem
- #### getItems
- #### clearCollection
- #### getAll
- #### Multiple insert