# mongochrome

> Simple and Quick MongoDB Wrapper with Caching System.

Latest version **0.0.3** (published 2020-12-19) · MIT license · 0 weekly downloads

> **Deprecated.** This package is deprecated.

## Install

```sh
npm install mongochrome
pnpm add mongochrome
yarn add mongochrome
bun add mongochrome
```

## Health

**Score 10/100 (F)** — status: deprecated.

Negative: deprecated.

## Facts

| | |
|---|---|
| Version | 0.0.3 |
| Published | 2020-12-19 |
| First published | 2020-12-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 5 |
| Unpacked size | 22 KB |
| Known vulnerabilities | 0 (+27 in 3 direct dependencies) |
| Install scripts | no |
| GitHub stars | 3 |
| Author | Rafly Maulana |
| Maintainers | raflymln |
| Keywords | mongochrome, mongodb, mongoose, wrapper, database, quickmongo, quickdb, discord, bots |

## Links

- npm: https://www.npmjs.com/package/mongochrome
- Repository: https://github.com/raflymln/mongochrome
- Homepage: https://mongochrome.my.id
- Issues: https://github.com/raflymln/mongochrome/issues
- npm.io page: https://npm.io/package/mongochrome

## Dependencies (5)

- [fs](https://npm.io/package/fs.md) 0.0.1-security
- [path](https://npm.io/package/path.md) ^0.12.7
- [axios](https://npm.io/package/axios.md) ^0.21.0
- [mongoose](https://npm.io/package/mongoose.md) ^5.11.8
- [simpleflakes](https://npm.io/package/simpleflakes.md) ^2.1.0

## Alternatives

- [angular-pipes](https://npm.io/package/angular-pipes.md) — 5.6K weekly downloads
- [@ng-web-apis/midi](https://npm.io/package/@ng-web-apis/midi.md) — 2.6K weekly downloads
- [happn-3](https://npm.io/package/happn-3.md) — 1.6K weekly downloads
- [@opensip-cli/lang-go](https://npm.io/package/@opensip-cli/lang-go.md) — 1.2K weekly downloads
- [mongoose-typescript](https://npm.io/package/mongoose-typescript.md) — 85 weekly downloads

## Recent versions

- 0.0.3 (latest) — 2020-12-19

## README

![Mongochrome](https://i.ibb.co/5Gd7rpX/Untitled-design-2-removebg-preview.png)

# Mongochrome
Mongochrome is a simple and fast MongoDB wrapper that **cached it's data**, so that you don't need to always fetch it from the server! Also this package is super **beginner friendly**.

**[Notice]** This package is inspired from Quickmongo package, so that you'll find it's similar in some way.

**[IMPORTANT]** Since this package is new, some features may be bugging, feel free to ask me if you have any question or if you found any bug!

## Links
1. Documentation: [mongochrome.my.id](https://mongochrome.my.id/)
2. Discord Support Server: [discord.gg/7z4CwpMF4w](https://discord.gg/7z4CwpMF4w)
3. NPM PACKAGE: [npmjs.com/package/mongochrome](https://www.npmjs.com/package/mongochrome)
3. Github: [github.com/raflymln/mongochrome](https://github.com/raflymln/mongochrome)
4. Bug Report: [github.com/raflymln/mongochrome/issues](https://github.com/raflymln/mongochrome/issues)

## Contribution
If you have any contributions, feel free to do a pull request against the *master* branch on Mongochrome github pages! I'll try to read on every pull request and accept it if it's good enough.

## Features
1. Asynchronous
2. Cached its Data
3. Beginner Friendly
4. Somewhat similar to *Quickmongo* / *Quick.db*
5. Easy to use

## Installation
[**📥 NPM PACKAGE**](https://www.npmjs.com/package/mongochrome)
```
npm install mongochrome
```

## Usage Example
```js
const Mongochrome = require('mongochrome');
const db = Mongochrome.Connect(url, connectOptions, options);

//This Function is Calling Database Class by Default
db(collectionName); 

// Setting Up a Single Object
db("character").set("user1", { stamina: {...} })

// Setting Up an Object in Object Value
db("character").set("user1.level", "5")

// Automatically create an array if data doesn't available before
db("character").push("list", ["char1", "char2"])

// You can also push directly into an Object
db("character").push("user1.items", ["sword", "banana"])

// Getting Full Data
db("items").get("sword")

// Getting an Object on Data
db("items").get("sword.level")

// Get All Collection Data
db("users").data
```

---
_Source: https://npm.io/package/mongochrome · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._