skbase v1.0.3

Skbase

Project

This project was created with the intent to make MySql query's more easier. Inspired by Firebase i decided to create something like it, so, SkBase was built! You can see the documentation right after installation.

• Installation
• Documentation
• Full Example
• License

Installation

#npm
npm install --save skbase

#yarn
yarn add skbase

Documentation

// CommonJS
const Skbase = require("skbase");
// ES6
import Skbase from "skbase";

List of functionabilities

• Initialize App

Initialize App

const application = new Skbase(...)

Initializes the database and sockets. They log the skbase listened url on console. The url port as default gonna be 2318.

const application = new Skbase(..., 5713) // <- Custom port

If you need change the port passing at second argument, before options.

Options:

• host: The hostname of the database you are connecting to. (Default: localhost)
• port: The port number to connect to. (Default: 3306)
• user: The MySQL user to authenticate as.
• password: The password of that MySQL user.
• database: Name of the database to use for this connection

Full example

const Skbase = require("skbase");
const application = new Skbase({
	host: "localhost",
	user: "me",
	password: "secret",
	database: "my_db",
});

// Skbase running on: localhost:2318

License

• See LICENSE