shorterurl Introduction

install package:

``
npm i --save shorterurl
`

this package is useful when you need to make your string safer and shorter.

- you can make your string shorter by method getShorter and this method give you a short token.

- for transfer your token to original string you should use method getOriginal and pass your token.

- for save the data in your memory instead database you should use method type and pass _MEMORY_ as an argument in that.

- for remove your un necessary data you can use method purge and you should pass a timestamp and then purge method delete all data before that time.

shorterurl is a _Promise_ base, so you only need to use it as an _await_.

shorterurl store a result in a _SQLite Database_ at _/shorterurl-database/database.sqlite_

Example:

##### get Short string/url :

`javascript
const shorter = require("shorterurl");
const LONG_URL = "https://www.npmjs.com/package/shorterurl"(
// make string/url Shorter
async () => {
const short = await shorter.getShorter(LONG_URL);
console.log("short url: ", short);
}
)(); // it's gave you a token like "1rfN5BOw3"
`

> if you want to validate getShorter token, we have used shortId in our package, so you can use _shortId_ for your token validation.

##### get Original string/url :

`javascript
const shorter = require("shorterurl");
const TOKEN = "1rfN5BOw3";
// pass shorter url and get the original url

(async () => {
const original_url = await shorter.getOriginal(TOKEN);
console.log("Original url: ", original_url);
})(); // it's gave you somting like https://www.npmjs.com/package/shorterurl
`

##### purge data :

`javascript
const shorter = require("shorterurl");

(async () => {
await shorter.purge(Date.now());
console.log("all data is deleted");
})();
`

##### save in memory :

`javascript
const shorter = require("shorterurl");
const LONG_URL = "https://www.npmjs.com/package/shorterurl";

(async () => {
await shorter.type("MEMORY");
const short = await shorter.getShorter(LONG_URL);
console.log("short url: ", short);
})();
``