opizo-api v0.1.1

opizo-api

opizo.com shortener api module for node.js. (client)
All functions return a promise

Persian version of readme

Installation

with npm:

$ npm install --save opizo-api   

or with yarn:

$ yarn add opizo-api

Example

Request to get short url:

const opizo = require('opizo-api');

// Not need to setUsername you can use without login

// Just request to short a url
opizo('http://example.com')
  .then((result) => {
    console.log(`Short url: ${result.shortUrl}\nRequested url: ${result.url}`);
  })
  .catch((err) => {
    console.log(err.message, err.rp.message); console.log(`Requested url: ${err.result.url}`);
  });

Request to get short url and file info:

const opizo = require('opizo-api');

// Optional (you can leave it blank or just don't call this function)
// username on here or set as environment varialbe
opizo.setUser('')

// Request to short a url and get file name and size info
opizo.extra('http://bayanbox.ir/thumb/8633283754319788500/GitHub-Logo.jpg')
  .then(result => {
    console.log(`Short url: ${result.shortUrl}\nRequested url: ${result.url}`);
    console.log(`fileName: ${result.fileInfo.name}\nfileSize: ${result.fileInfo.sizeInMB}`);
  })
  .catch(err => {
    console.log(err.message, err.rp.message);
    console.log(`Requested url: ${err.result.url}`);
  });

functions

Use main function, when you require module you can use it as function like below(opizo is the variable name but after required it is main function):

const opizo = require('opizo-api');

• opizo(your-url): request short link
• opizo.extra(your-url): request short link & file info
• opizo.setUse(your-username): optional, set the username to make your link manageable, you can also use environment variable like this:

  $ export OPIZO_USERNAME='your-user-name-here'

  or just don't call this function.

Result object

On main function returned result object have below property:

• url: Requested url
• shortUrl: short url if request not failed

On extra function returned result object have below property:

• url: Requested url
• shortUrl: Short url if request not failed
• fileInfo: File info if request not failed
  • name: File name if exists
  • sizeInMB: File size in pretty format
  • contentLength: File size in kb

err object

Error object on catch have below property:

• code: Internal error code
• message: Internal error message
• result: This is result object
• rp: More details
  • code: Error code
  • message: Error message