https://github.com/artdecocode/mondo-bongo
The Lightweight MongoDB Interface.
https://github.com/artdecocode/mondo-bongo
Last synced: about 2 months ago
JSON representation
The Lightweight MongoDB Interface.
- Host: GitHub
- URL: https://github.com/artdecocode/mondo-bongo
- Owner: artdecocode
- License: mit
- Created: 2019-02-07T08:42:21.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2019-02-07T08:45:51.000Z (almost 7 years ago)
- Last Synced: 2025-02-08T09:24:14.724Z (11 months ago)
- Language: JavaScript
- Homepage: https://artd.eco
- Size: 16.6 KB
- Stars: 1
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
Awesome Lists containing this project
README
# mondo-bongo
[](https://npmjs.org/package/mondo-bongo)
`mondo-bongo` is The Lightweight MongoDB Interface.
```sh
yarn add -E mondo-bongo
```
## Table Of Contents
- [Table Of Contents](#table-of-contents)
- [API](#api)
- [`mondoBongo(arg1: string, arg2?: boolean)`](#mondobongoarg1-stringarg2-boolean-void)
* [`Config`](#type-config)
- [Copyright](#copyright)
## API
The package is available by importing its default function:
```js
import mondoBongo from 'mondo-bongo'
```
## `mondoBongo(`
`arg1: string,`
`arg2?: boolean,`
`): void`
Call this function to get the result you want.
__`Config`__: Options for the program.
| Name | Type | Description | Default |
| --------- | --------- | ----------------- | ------- |
| shouldRun | _boolean_ | A boolean option. | `true` |
| __text*__ | _string_ | A text to return. | - |
```js
/* yarn example/ */
import mondoBongo from 'mondo-bongo'
(async () => {
const res = await mondoBongo({
text: 'example',
})
console.log(res)
})()
```
```
example
```
## Copyright
© Art Deco
2019
Tech Nation Visa Sucks
