ldbjs - npm Package Compare versions

Comparing version 0.0.5 to 0.0.6

index.js

@@ -82,2 +82,4 @@ const fs = require('fs');
 		if(callback) callback(data);
+
+		return data;
 	});
@@ -84,0 +86,0 @@ }

package.json

 {
   "name": "ldbjs",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Create and manage local db files and data",
   "main": "./index.js",
-  "keywords": [],
+  "keywords": ["backend", "frontend", "fullstack", "local", "electron", "db", "data", "files"],
   "author": "raisess-Danilo_Santana",
@@ -8,0 +8,0 @@ "preferGlobal": "true",

README.md

 # ldb
-banco de dados local (offline) para aplicações nodejs, electron, etc
+A lib to create and manage local db files and data, whit a simple send and get system,  
+save any data, html content, js objects and arrays, some texts, anything.
+
+
+##### The erros in the operations is automatically returned not include in yours callbacks.
+
+### Creating a db location folder
+
+```javascript
+	const ldb = require('ldbjs');
+	ldb.createDB('.', 'myDB'); // optional callback
+```
+
+And your db are created.
+
+
+### Creating DB file
+
+```javascript
+	const ldb = require('ldbjs');
+	ldb.createDB('.', 'myDB'); // optional callback
+	ldb.createDBFile('./myDB', 'myDBFile'); // optional callback
+```
+
+The file extension are **.ldb**.
+
+
+### Sending data to my dbfile
+
+```javascript
+	const ldb = require('ldbjs');
+	ldb.createDB('.', 'myDB');
+	ldb.createDBFile('./myDB', 'myDBFile');
+
+	let myData = 'Hello World!';
+
+	ldb.sendData('./myDB', 'myDBFile', myData, ()=>{
+		// this callback is optional
+		console.log(`${myData} as been sended to my ldb DB!`);
+	});
+```
+
+Sent data is saved **exactly** as sent
+
+
+### Getting data from dbfile
+
+```javascript
+	// electron example
+	const ldb = require('ldbjs');
+
+	let myPTag = document.getElementById('myP');
+
+	myPTag.innerHTML = ldb.getData('./myDB', 'myDBFile'); // returns data of the file
+	console.log(ldb.getData('./myDB', 'myDBFile')); // returns data in buffer format of the file
+
+	ldb.getData('./myDB', 'myDBFile', (data)=>{ // optional callback
+		myPTag.innerHTML = data;
+	});
+```
+
+The returned value is a json with the properties type and data, type is buffer and data is content,  
+while **on console** prints **array with buffer**, while on **html component returns  
+exactly the data on the screen**.
+
+
+### To overwrite data of the file
+
+```javascript
+	const ldb = require('ldbjs');
+	ldb.createDB('.', 'myDB');
+	ldb.createDBFile('./myDB', 'myDBFile');
+
+	let myData = 'I overwrited data!';
+
+	ldb.overwriteData('./myDB', 'myDBFile', myData); // optional callback
+```
+
+That action is **irreversible**.
+
+
+### Cloning the content to other dbfile
+
+```javascript
+	const ldb = require('ldbjs');
+	ldb.createDB('.', 'myDB');
+	ldb.createDBFile('./myDB', 'myDBFile');
+	ldb.createDBFile('./myDB', 'myOtherDBFile');
+
+	let myData = 'I overwrited data!';
+
+	ldb.sendData('./myDB', 'myDBFile', myData); // optional callback
+
+	ldb.cloneDBFile('./myDB', 'myDBFile', './myDB', 'myOtherDBFile', ()=>{ // optional callback
+		console.log('')
+	});
+```
+
+To clone a file you need the two files created.
+
+### Deleting a dbfile
+
+```javascript
+	const ldb = require('ldbjs');
+	ldb.deleteDBFile('./myDB', 'myDBFile', ()=>{ // optional callback
+		console.log('the dbfile as been deleted');
+	});
+```
+
+That action is **irreversible**.
+
+### To rename a dbfile
+
+```javascript
+	const ldb = require('ldbjs');
+	ldb.renameDBFile('./myDB', 'myDBFile', 'myNewDBFileName');
+```
+
+This function **not receive a callback**, are shown in the console the new stats of the file.

No alert changes

Improved metrics

Total package byte prevSize

5303

increased by132.28%

Lines of code

65

increased by1.56%

Number of lines in readme file

120

increased by3900%

No dependency changes