Newton's Programmatic Measurements

    dingle-nodejs

    0.3.5 • Public • Published

    Dingle NodeJS

    Dingle Generator for NodeJS

    Installation

    $ npm install --save dingle-nodejs

    Dependancies

    You will need the following module in your project:

    npm install --save request

    Usage

    Simply require the dingle generator module and specify the directory to build into:

    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:

    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:

    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:

    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:

    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:

    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

    Install

    npm i dingle-nodejs

    DownloadsWeekly Downloads

    0

    Version

    0.3.5

    License

    MIT

    Last publish

    Collaborators

    • victor96