@neko-odd/neko.db-wrapper v1.0.9

neko.db-wrapper

This is an API wrapper for neko.db.

Documentation

• Class: Wrapper
  • new Wrapper(options)
  • wrapper.create(name)
  • wrapper.connect(name)
  • wrapper.disconnect()
  • wrapper.set($var, $val)
  • wrapper.get($var)
  • wrapper.delete($var)

Example code

Wrapper

new Wrapper(options)

Constructs a new Wrapper object.

• options <Object>
  • url <String> The database URL to connect to
  • password <String> The password used for databases
  • verbosity <Number> An optional (default: 110) bitfield of 3 bits representing the verbosity level (100 = errors, 010 = warnings, 001 = verbose)

wrapper.create(name)

Creates a database.

• name <String> The name of the created database

wrapper.connect(name)

Connects to a database.

• name <String> The name of the database to connect to

wrapper.disconnect()

Disconnects from the current database.

wrapper.set($var, $val)

Sets a variable on the database to a value.

• $var <String> The variable's name
• $val <String> | <Number> | <Array> The value for the variable

wrapper.get($var)

Gets a variable's value from the database.

• Returns <String> | <Number> | <Array>

• $var <String> The variable's name

wrapper.delete($var)

Deletes a variable from the database.

• $var <String> The variable's name

Example code

const Wrapper = require("@neko-odd/neko.db-wrapper");

var wrapper = new Wrapper({
    'url': 'http://neko-db.glitch.me/',
    'password': 'pass',
    'verbosity': 0b111
});
 
wrapper.create('asdf').then(async res => {
    await wrapper.connect('asdf');
    await wrapper.set('test', 'Hello world');
    console.log(`test = ${await wrapper.get('test')}`);
    await wrapper.delete('test');
    wrapper.disconnect();
});