https://github.com/night-codes/euphoria
euphoria
https://github.com/night-codes/euphoria
Last synced: 3 months ago
JSON representation
euphoria
- Host: GitHub
- URL: https://github.com/night-codes/euphoria
- Owner: night-codes
- License: mit
- Created: 2014-08-09T13:35:34.000Z (almost 11 years ago)
- Default Branch: master
- Last Pushed: 2016-02-23T13:55:35.000Z (over 9 years ago)
- Last Synced: 2025-01-23T23:32:55.529Z (5 months ago)
- Language: JavaScript
- Size: 23.4 KB
- Stars: 1
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Euphoria
Simple object database for Node.JS (experiment, not for production =) )
## Getting Started
```javascript
var eu = require('euphoria');
// or:
// var eu = require('euphoria').cluster(false);
var obj = {}, obj2 = {"foo": "bar"};
eu.connect(obj, "db1", function(err) {
if(!err)
console.log("obj sync started!");
});
eu.connect(obj2, "db2", function(err) {
if(!err)
console.log("obj2 sync started!");
});
```
## Documentation
**euphoria.connect**
```javascript
/**
* Connect object to DB.Euphoria
*
* @param {Object} object Object for sync
* @param {String} name Name of database file for sync (will be created automatically).
* @param {Function} callback
*
* That's all) After calling callback you can work with the object as
* if nothing had happened - it will saved at intervals of 20 seconds
* in a separate thread, then restart or crash the application it will
* be restored.
*/
eu.connect(object, name, callback);
```
**euphoria.disconnect**
```javascript
/**
* Disonnect object to DB.Euphoria (with savig)
*
* @param {String} name Name of database for load.
* @param {Function} callback
*/
eu.disonnect(name, callback);
```
**euphoria.load**
```javascript
/**
* Load database file to your object (without permanent sync)
*
* @param {Object} object Object for load
* @param {String} name Name of database file for load.
* @param {Function} callback
*/
eu.load(object, name, callback);
```
**euphoria.save**
```javascript
/**
* Save your object to database file (without permanent sync)
*
* @param {Object} object Object for save
* @param {String} name Name of database file for save (will be created automatically).
* @param {Function} callback
*/
eu.save(object, name, callback);
```
## License
MIT License
Copyright (C) 2014 Oleksiy Chechel ([email protected])
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.