{"_id":"@brillout/proto-db","_rev":"2-2129b99159a193149bcd6ea88ca10753","name":"@brillout/proto-db","dist-tags":{"latest":"0.1.1"},"versions":{"0.1.0":{"name":"@brillout/proto-db","version":"0.1.0","scripts":{"docs":"mdocs"},"dependencies":{"@brillout/assert":"^0.1.0","fs-extra":"^8.1.0"},"devDependencies":{"@brillout/mdocs":"^0.1.30"},"repository":{"type":"git","url":"git+https://github.com/brillout/proto-db.git"},"publishConfig":{"access":"public"},"gitHead":"6f71d00ea646e0940478baf145a9407905c6e0b1","description":"\n# ProtoDB\n\n

\nWhat is ProtoDB\n  |  \nWhy ProtoDB\n  |  \nUsage\n  |  \nAPI\n

\n\n### What is ProtoDB\n\nProto is a small Node.js tool to persist a JavaScript object to disk.\n\n### Why ProtoDB\n\nAt the early prototyping phase of several projects,\nwe were too lazy to set up a proper database and\ninstead we used a JavaScript object and persisted it by reading & writing JSON to disk.\n\nWe expected that our approach wouldn't survive long\nand that we would soon need to replace our lazy hack with a real database.\nBut, and to our biggest surprise, we got quite far until we had to use a real database.\n\nProto is only ~40 lines of code ([/index.js](/index.js)),\nso you can easily modify it and write your own implementation.\n\nWe actually encourage you to write your own implementation;\nProtoDB is a cheering message that the technique of using JSON and the filesystem can be a great alternative to a database for prototypes and small to medium-sized apps.\nYou may not use Proto but you may want to consider this technique.\n\n\n### Usage\n\nIdiomatic usage example:\n\n~~~js\n// /example/db/index.js\n\nconst proto = require('@brillout/proto-db'); // npm install @brillout/proto-db\n\nconst data = proto.load(__dirname+'/data.json', {todos: []});\n\nmodule.exports = {createTodo, getAllTodos};\n\nasync function createTodo({text}) {\n const id = proto.getUUID();\n const newTodo = {id, text};\n\n data.todos.push(newTodo);\n\n await data._save();\n}\n\nfunction getAllTodos() {\n return data.todos;\n}\n~~~\n~~~js\n// /example/index.js\n\nconst db = require('./db');\n\nrun();\n\nasync function run() {\n await db.createTodo({text: 'Buy Milk'});\n\n const todos = db.getAllTodos();\n console.log(todos);\n}\n~~~\n\nWhich prints:\n~~~shell\n$ node example/\n[ { id: 430557952207, text: 'Buy Milk' } ]\n~~~\n\nThe new todo item is saved as JSON in `data.json`:\n~~~shell\n$ cat example/db/data.json\n{\"todos\":[{\"id\":199451513185,\"text\":\"Buy Milk\"}]}\n~~~\n\n### API\n\n- `const data = proto.load(databaseFile, defaultValue)` loads and returns the JavaScript object saved at `databaseFile`. If there is no file at `databaseFile` then `defaultValue` is used. The `proto.load` function is synchronous.\n- `await data._proto.save()` saves `data` to the disk at the path `databaseFile` you provided when running `const data = proto.load(databaseFile)`.\n- `proto.getUUID()` generates and returns a universally unique ID.\n\n\n","readmeFilename":"readme.md"}