@turph/quickmongo

quick.mongo

Simple Database using MongoDB. The name is a copy of quick.db, this uses the Mongo Atlas Database to store data though

Documentation

new Database()

new database(mongo url, options)

Parameter	Type	Optional	Description
Mongo URL	URL	✖	The URL given to you by the MongoDB Atlas Connection
options	Object	null	null
options.name	String	✖	The name of the collection you want to create

Example

  const quickMongo = require('@turph/quickmongo');
  
  const database = new quickMongo('{ INSERT MONGO URL HERE }', { name: 'database' });
  db
  .on('error', err => console.log(err))
  .on('connected', info => console.log(info));

Constructor

database.set()

database.set(key, value)

Parameter	Type	Optional	Description
Key	String	✖	The key of the value
Value	String / Object	✖	The value of the key you wish to set

Example

await database.set('foo', 'fee');

Returns Promise<Boolean>

database.get()

await database.get(key)

Parameter	Type	Optional	Description
key	String	✖	The key of that vakue you wish to find

Example

await database.get('foo'); // fee

Returns Promise<String>

database.search()

database.search(query)

Parameter	Type	Optional	Description
query	String	✖	The term you wish to search for

Example

await database.search('foo');

Returns Promise<Object>

database.find()

database.find(query)

Parameter	Type	Optional	Description
query	String	✖	The term you wish to search for

Example

await database.find('foo');

Returns Promise<Object>

database.all()

database.all()

Parameter	Type	Optional	Description

Example

await database.all()

Returns Promise<Object>

database.delete()

database.delete(key)

Parameter	Type	Optional	Description
Key	String	✖	The key of the value you wish to delete

Example

await database.delete('foo');

Returns Promise<Boolean>

database.clear()

database.clear(key)

Parameter	Type	Optional	Description
Key	String	✖	The key of the value you wish to clear from your database. Note: this will delete ALL matches so perform at your own risk

Example

await database.clear('foo');

Returns Promise<Boolean>

database.push()

database.push(key, values)

Parameter	Type	Optional	Description
Key	String	✖️	The key you want to push values into
Values	Array	✖️	The values you want to push into

Example

await database.push('foo', ['fee', 'foo'])

Returns Promise<Boolean>

Extra Information

This will not be updated frequently and will most likely only be updated for bug fixes. Extra features will not be added.

Contributors

Tur-ph