README

Basic-ToolsJS

Math - anything from subtract to multiply.
Random - random strings, random integers, etc.
Currency.
Checks - email validation, username validation, etc.
Decryption.
Encryption.
Checks.
GeoIP
Status Codes

Quickstart

Installation

npm install basic-toolsjs

Math

Addition

const { add } = require('basic-toolsjs').math; 

add([1, 2, 3, 4]); // => 10

Subtraction

const { subtract } = require('basic-toolsjs').math; 

subtract([1, 2, 3, 4]); // => -8

Multiplication

const { multiply } = require('basic-toolsjs').math; 

multiply([1, 2, 3, 4]); // => 24

Division

const { divide } = require('basic-toolsjs').math; 

divide([1, 2, 3, 4]); // => 0.041666666666666664

Random

Random String

const { randomString } = require('basic-toolsjs').random;

randomString(50); // => LxIwMerj4fkiP9TiTlvNnCAlz5LuAfVkFesqD6xHziqaZSKWsF

Random Int

const { randomInt } = require('basic-toolsjs').random;

randomInt(250000); // => 205680

Random Float

const { randomFloat } = require('basic-toolsjs').random;

randomFloat(2737823823.1273); // => 488491739.87192076

Currency

Format

const { format } = require('basic-toolsjs').currency;

format(1000000, 'USD'); // => $1,000,000.00

Unformat

const { unformat } = require('basic-toolsjs').currency;

unformat('$1,000,000.00', 'USD'); // => 1000000

Find

const { find } = require('basic-toolsjs').currency;

find('USD');
// => 
{
  code: 'USD',
  symbol: '

,
  thousandsSeparator: ',',
  decimalSeparator: '.',
  symbolOnLeft: true,
  spaceBetweenAmountAndSymbol: false,
  decimalDigits: 2
}

Currencies

const { currencies } = require('./index').currency;

currencies(); // =>
[
  {
    code: 'AED',
    symbol: 'د.إ.‏',
    thousandsSeparator: ',',
    decimalSeparator: '.',
    symbolOnLeft: true,
    spaceBetweenAmountAndSymbol: true,
    decimalDigits: 2
  },
  {
    code: 'AFN',
    symbol: '؋',
    thousandsSeparator: ',',
    decimalSeparator: '.',
    symbolOnLeft: true,
    spaceBetweenAmountAndSymbol: false,
    decimalDigits: 2
  },
  {
    code: 'ALL',
    symbol: 'Lek',
    thousandsSeparator: '.',
    decimalSeparator: ',',
    symbolOnLeft: false,
    spaceBetweenAmountAndSymbol: false,
    decimalDigits: 2
  },
  {
    code: 'AMD',
    symbol: '֏',
    thousandsSeparator: ',',
    decimalSeparator: '.',
    symbolOnLeft: false,
    spaceBetweenAmountAndSymbol: true,
    decimalDigits: 2
  }
  ... 60+ more
]

Encryption

Base64

const { base64 } = require('basic-toolsjs').encryption;

base64('Hello, World!'); // => SGVsbG8sIFdvcmxkIQ==

Hash

const { hash } = require('basic-toolsjs').encryption;

const result = async (str, salt) => {
  const res = await hash(str, salt);
  return res
}

result('Hello, World!', 12); // => $2a$12$tfUaj.b/i1daOlo4sLtr1uMJog0EdBHH.UeE17hfAbgaY1v2juDfe - Always different.

MD5

const { md5 } = require('basic-toolsjs').encryption;

md5('Hello, World!'); // => 65a8e27d8879283831b664bd8b7f0ad4

Decryption

Base64

const { base64 } = require('basic-toolsjs').decryption;

base64('SGVsbG8sIFdvcmxkIQ=='); // => Hello, World!

Checks

Email

const { email: emailCheck } = require('basic-toolsjs').checks;


const validate = async (email) => {
  const result = await emailCheck(email);

  console.log(result)
}

validate('Hello, World!'); // => false

String

const { string } = require('basic-toolsjs').checks;

string('Hello, World!');

Integer

const { string } = require('basic-toolsjs').checks;

string('Hello, World!'); // => true

Float

const { float } = require('basic-toolsjs').checks;

console.log(float('Hello, World!')); // => false

GeoIP

IPLookup

const { iplookup } = require('basic-toolsjs').geoip;


const lookup = async (ip) => {
  const res = await iplookup(ip);

  console.log(res);
}

lookup('1.1.1.1'); // =>
{
  "ip": "1.1.1.1",
  "version": "IPv4",
  "city": "Sydney",
  "region": "New South Wales",
  "region_code": "NSW",
  "country": "AU",
  "country_name": "Australia",
  "country_code": "AU",
  "country_code_iso3": "AUS",
  "country_capital": "Canberra",
  "country_tld": ".au",
  "continent_code": "OC",
  ... 14+ more
}

Status Codes

Codes

Find more information here: (https://en.wikipedia.org/wiki/List_of_HTTP_status_codes)

Usage no npm install needed!