https://github.com/agrublev/local-database
https://github.com/agrublev/local-database
Last synced: over 1 year ago
JSON representation
- Host: GitHub
- URL: https://github.com/agrublev/local-database
- Owner: agrublev
- Created: 2022-02-21T16:48:08.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-01-24T06:55:19.000Z (over 2 years ago)
- Last Synced: 2025-02-15T06:41:26.474Z (over 1 year ago)
- Language: JavaScript
- Size: 167 KB
- Stars: 0
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
README
# Local Database
A simple and efficient JavaScript library for managing local storage in web applications.
## Table of Contents
- [Introduction](#introduction)
- [Features](#features)
- [Installation](#installation)
- [Usage](#usage)
- [Code Examples](#code-examples)
- [Testing](#testing)
- [Contributing](#contributing)
- [License](#license)
## Introduction
`a-local-database` is a lightweight, easy-to-use JavaScript library designed to simplify interactions with local storage in web browsers. It provides a straightforward API for storing, retrieving, and managing data efficiently.
## Features
- **Simple API**: Easy-to-use methods for storing and retrieving data.
- **Data Parsing**: Automatic handling of different data types.
- **Error Handling**: Robust error management for reliable data operations.
- **Modular Design**: Easily extendable for different storage mechanisms.
## Installation
Install the library using yarn:
```bash
yarn add a-local-database
```
Or include it directly in your HTML:
```html
```
## Usage
To start using the library, create a new `Collection` instance:
```javascript
import { Collection } from "a-local-database";
const myCollection = new Collection();
```
## Code Examples
### Setting and Getting Data
```javascript
myCollection.set({ key: "value" });
console.log(myCollection.get("key")); // Outputs: value
```
## Testing
This project uses Jest for testing. Run tests with:
```bash
yarn test
```
## Contributing
Contributions are welcome!
## License
This project is licensed under the MIT License