https://github.com/vmlweb/dingle-nodejs
Dingle Generator for NodeJS
https://github.com/vmlweb/dingle-nodejs
Last synced: 4 months ago
JSON representation
Dingle Generator for NodeJS
- Host: GitHub
- URL: https://github.com/vmlweb/dingle-nodejs
- Owner: Vmlweb
- License: mit
- Created: 2015-05-29T11:48:03.000Z (about 11 years ago)
- Default Branch: master
- Last Pushed: 2015-07-08T12:46:30.000Z (almost 11 years ago)
- Last Synced: 2025-12-19T17:26:09.665Z (6 months ago)
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/dingle-javascript-nodejs
- Size: 152 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Dingle NodeJS
[Dingle](https://github.com/Vmlweb/Dingle) Generator for NodeJS
## Installation
```bash
$ npm install --save dingle-nodejs
```
## Dependancies
You will need the following module in your project:
* [Request](https://github.com/request/request)
```javascript
npm install --save request
```
## Usage
Simply require the dingle generator module and specify the directory to build into:
```javascript
var dingle = require('dingle')({
http_listen: '0.0.0.0',
https_listen: '0.0.0.0',
tcp_listen: '0.0.0.0',
udp_listen: '0.0.0.0'
});
var generator = require('dingle-nodejs');
generator.generate(dingle, './exports/nodejs');
```
Then simply drop the files generated into your node project and use like so:
```javascript
var myapi = require('./MYAPI.js');
myapi.login('admin@myawesomeapi.com', 'mypassword', function(success, message, output){
console.log(success);
console.log(message);
console.log(output);
});
```
## Hostnames
When the code is generated your hostnames are automatically taken from the dingle config but you can change it like so:
```javascript
var myapi = require('./MYAPI.js');
myapi.http = "localhost:7691";
myapi.https = "localhost:7692";
myapi.tcp = "localhost:7693";
myapi.udp = "localhost:7694";
myapi.login('admin@myawesomeapi.com', 'mypassword', function(success, message, output){
console.log(success);
console.log(message);
console.log(output);
});
```
## File Uploads
To upload a file simply specify a read stream as a parameter as shown below:
```javascript
var fs = require('fs');
var myapi = require('./MYAPI.js');
myapi.upload_file('admin@myawesomeapi.com', fs.createReadStream("./myawesomefile.png"), function(success, message, output){
console.log(success);
console.log(message);
console.log(output);
}, [ "POST", "GET" ], function (size, remaining, progress){
console.log('Upload at ' + progress + '%');
});
```
## File Downloads
When downloading a file you must specify a stream to write to and once the download is complete the stream will be returned in the output variable callback:
```javascript
var fs = require('fs');
var myapi = require('./MYAPI.js');
myapi.download_file('admin@myawesomeapi.com', 'mypassword', function(success, message, output){
console.log(success);
console.log(message);
console.log(output);
}, null, function (size, remaining, progress){
console.log('Upload at ' + progress + '%');
}, function (size, remaining, progress){
console.log('Download at ' + progress + '%');
}, fs.createWriteStream('./myawesomefile.mov'));
```
## Choosing Method
By default dingle will auto choose each method depending on the order of which they are specified in the function but we can override this like so:
```javascript
var myapi = require('./MYAPI.js');
myapi.login('admin@myawesomeapi.com', 'mypassword', function(success, message, output){
console.log(success);
console.log(message);
console.log(output);
}, [ "POST", "GET" ]);
```
## Methods
The following methods are supported:
* TCP
* UDP
* POST
* GET
* PUT
* DELETE
* OPTIONS
* HEAD
* PATCH
* TRACE
* CONNECT