Skip to content

Not currently maintained, here as a reminder for an upcoming project.

Notifications You must be signed in to change notification settings

ozzie1998/WaxDB

Repository files navigation

WaxDB

A NoSQL REST database using Redis written in NodeJS.

Documentation is currently in the works!

Will be seperating docs into a seperate file soon!

Documentation:

The server is made up of reusable functions called components.

Documentation for each component:

Async DB operations

  1. createAccount

This component is used to create an entry in the database.

const createAccount = component("/async_dbOperations", "createAccount");
// working on a better component function
// probably better to use an async IFFE
const performQuery = async data => {
  const query = await createEntry(data).catch(e => {
    return new Error(e);
  });
  // query => { success: true, message: "createdAccount" };
};
  1. findUser

This component can be used to check if an account exists and to fetch the info from the database about the user

const deleteUser = component("/async_dbOperations", "findUser");

const performQuery = async username => {
  const query = await deleteUser(username).catch(e => {
    return new Error(e);
  });
  // query => user data*
};

About

Not currently maintained, here as a reminder for an upcoming project.

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published