1.2.0 • Published 2 years ago

robot-npm-ip-holder v1.2.0

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

robot-npm-ip-holder

1.2.0

npm module for working with we service ipHolder This module help you to get and/or send your IP address to the server.

install

npm install robot-npm-ip-holder --save

Usage-byServer

/*
* This Example works for server side usage
*/

/*
* Add module to the project using require
*/
const { IP } = require('robot-npm-ip-holder');

/*
* declare variables of url of the host that wait for your data and your device id
*/
const url = 'https://myHolderHost.com/api/v1/ipHolder';
const id = '555';
const customIP = '127.0.0.1' | 'false';

/*
* Create an objet of the class IP and put there your url and id.
*/
const sendIP = new IP(url, id);

/*
* Create an object of the class IP in customIP mode. Put there your url and id and custom ip.
*/
const sendIP = new IP(url, id, customIP);


/*
* Call IP's method sendIP, to send your ip to the host.
* The method returns object.
* The call mast be in the async function.
*/
(async () => {
    const response = await sendIP.sendIP();
    console.log(response);
})();

/*
* Call IP's method getIP to get your ip.
* The method returns string.
*/
(() => {
    const response = sendIP.getIP();
    console.log(response);
})();

Usage-byClient

/*
* This Example works for client side usage.
*/

/*
* Add module to the project using require.
*/
const { getIpByProductId } = require('robot-npm-ip-holder');

// The url of service's route for request.
const serviceUrl = 'https://ip-holder.herokuapp.com/api/v1/ipHolder';
// Var that service will put ip from response to.
let IP = '';

/*
* Call module method to get IP.
* The method returns string.
* The call mast be in the async function.
*/
(() => {
    const response = sendIP.getIP();
    console.log(response);
})();

references