manuelmaciel / skydb Goto Github PK

View Code? Open in Web Editor NEW

3.0 1.0 1.0 332 KB

a JSON powered database (yes, another one)

Home Page: https://www.npmjs.com/package/skydb

License: GNU General Public License v3.0

JavaScript 100.00%

database json-database nodejs npm-package javascript hacktoberfest npm-packages easy-to-use

skydb's Introduction

Welcome to SkyDB 👋

a JSON powered database (yes, another one) so far you can create templates (kind of like documents), create data, search, filter, update and remove

🏠 Homepage

TODO

TODO.

Install

npm install

Usage

create model

parameters: model: model name

import skyDB from 'skydb/lib'
skyDB.connection('users');

create records

parameters: model: model name, options: {data to be saved, pass as an object}

import skyDB from 'skydb/lib'
skyDB.create('users', { 'fieldName': 'manuel', 'age': 18 })

get data by id

parameters: model: model name, id: record id

import skyDB from 'skydb/lib'
const getDataById = async () => {
   const value = await skyDB.getById('users','v2dw1efZ5a')
   console.log(value)
}

getDataById()

get all data

parameters: model: model name, options: {order: [DESC or ASC, the name of the model data key], where: {the name of the model data key: value you want to find}}

import skyDB from 'skydb/lib'
const getAllData = async () => {
 const value = await skyDB.getAll('users', {order: ['DESC', 'fieldName'], where: {'fieldName': 'manuel'}})
 console.log(value)
}
getAllData()

update records

parameters: model: model name, id: record id, options: {value you want to find want to find}

import skyDB from 'skydb/lib'
const updateData = async () => {
 const value = await skyDB.update('users', 'v2dw1efZ5a', {'fieldName': 'manuel'})
 console.log(value)
}

updateData()

remove records

parameters: model: model name, id: id of the record to be deleted

import skyDB from 'skydb/lib'
const removeData = async () => {
 const value = await skyDB.remove('users', 'v2dw1efZ5a')
 console.log(value)
}

removeData()

Run tests

npm run test

Author

👤 ManuelMaciel

Website: manuelmaciel.vercel.app
Twitter: @m_maciel6
Github: @ManuelMaciel
LinkedIn: @manuelmaciel7

🤝 Contributing

Contributions, issues and feature requests are welcome!
Feel free to check issues page. You can also take a look at the contributing guide.

Thanks goes to these wonderful people (emoji key):

_{Diego Prestes}
🚇

⚠️

💻

This project follows the all-contributors specification. Contributions of any kind welcome!

Show your support

Give a ⭐️ if this project helped you!

📝 License

This README was generated with ❤️ by readme-md-generator

skydb's People

Contributors

Stargazers

Watchers

Forkers

diegolikescode

skydb's Issues

[bug]: order by does not work

I'm submitting a ...
- bug report
- feature request
- support request => Please do not submit support request here, see note at the top of this template.
Do you want to request a feature or report a bug?
no
What is the current behavior?
the parameter of the function getAll, sort by is not sorting in ascending or descending order
What is the expected behavior?
it should sort in ascending order of the value to be sorted and descending order but it would not be sorting at all
What is the motivation / use case for changing the behavior?
The data that is brought from the json can be sorted.
Please tell us about your environment:
- Version: 1.1.0
- Browser: none
- Language: JS
Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)
check the function on line 33 in the code of getAll

Add tests

I'm submitting a ...
- bug report
- feature request
- support request => Please do not submit support request here, see note at the top of this template.
Do you want to request a feature or report a bug?
feature
What is the current behavior?
add test to project, use jest for development
What is the expected behavior?
What is the motivation / use case for changing the behavior?
improve the development process
Please tell us about your environment:
- Version: 2.0.0-beta.X
- Browser: [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ]
- Language: [all | TypeScript X.X | ES6/7 | ES5 | Dart]
Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)

Migrate from js to ts

I'm submitting a ...
- bug report
- feature request
- support request => Please do not submit support request here, see note at the top of this template.
Do you want to request a feature or report a bug?
feature
What is the current behavior?

What is the expected behavior?
migrate the code from javascript to typescript
What is the motivation / use case for changing the behavior?

Please tell us about your environment:
- Version: 2.0.0-beta.X
- Browser: [all | Chrome XX | Firefox XX | IE XX | Safari XX | Mobile Chrome XX | Android X.X Web Browser | iOS XX Safari | iOS XX UIWebView | iOS XX WKWebView ]
- Language: [all | TypeScript X.X | ES6/7 | ES5 | Dart]
Other information (e.g. detailed explanation, stacktraces, related issues, suggestions how to fix, links for us to have context, eg. stackoverflow, gitter, etc)