yannickcr / node-synology

A simple wrapper for the Synology NAS API

Node Synology

A simple wrapper for the Synology NAS API.

Installation

$ npm install synology

Usage

var Synology = require('synology');

var syno = new Synology({
	host    : 'localhost',
	user    : 'mylogin',
	password: 'mypassword'
});

syno.fileStation.upload({
  file: fs.createReadStream(path.join(__dirname, 'foo.txt')),
  dest_folder_path: '/home'
}, function(err, data) {
  if (err) throw err;
  console.log(data);
});

API documentation can be found on the Wiki

It's a pretty big (non-documented) API and I need to reverse every methods and guess the parameters, document it then do a usable wrapper. Not very difficult for the majority of the methods but really time consuming. Help is welcome ;)

For now you can still use directly the Synology.query method to do a raw query but it is not very user friendly.

TODO

• Documentation (In progress)
• Helpers (In progress)
• Tests

License

Node Synology is licensed under the MIT License.

node-synology's Issues

What is this for?

Hi,
if this Project is stil alive, can the dev please tell, what's the reason for this thing/tool/code?
Whats its use? How could we use it? etc.
Cheers,

NPM package out of sync

When getting this package via NPM the code seems to be out of sync with the code on github. In the package.json, api.js is set as the main file and nothing else than app.js is included in the lib folder.