Skip to content

cinaaaa/pleex

Repository files navigation

pleex

Pleex

💣 " Schematic " ➕ " Storage " 💣 for ⚛️ react native


Built with ❤ Sina Farhadi


Get Started

Installation

install pleex with npm or yarn

npm i pleex

or

yarn add pleex

also pleex don't need any extra configuration or installation with gradle or pods

Want to see example? see youtube tutorial

YOUTUBE

Example Usage

Full example and list of api's can be find in pleex documents
this is example of creating schemas with pleex

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

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

Current api's:

  • Collection

  • Schema

  • Insert

  • removeItem

  • removeItems

  • getItem

  • getItems

  • clearCollection

  • getAll

  • Multiple insert