ako-prototypes

Some Useful Prototypes For Every JS lover

Installation

Node

First You Have to Install Package

npm i ako-prototypes

Then Simply Import It to Your Project

// ES
import 'ako-prototypes';

// Module
require('ako-prototypes');

Browser

Just Add Script Tag to Your HTML Page And Tadaa :)

<!-- CDN -->
<script src="https://cdn.jsdelivr.net/npm/ako-prototypes/dist/ako-prototypes.min.js"></script>
<!-- Local -->
<script src="path/to/package/dist/ako-prototypes.min.js"></script>

Usage

Array Prototypes

• distinct: Distincs Base Array by func Declaring Property
  • param Function func
  • returns Array

  /* Normal Array */
  var arr = [1,2,2,2,3,4,5];
  arr.distinct(); // [1,2,3,4,5]
  
  /* Array of Objects */
  var arr = [{a:1,b:1}, {a:2,b:2}, {a:1,b:3}];
  arr.distinct(x => x.a) // [{a:1,b:1}, {a:2,b:2}]

• shuffle: Shuffle Order Base Array
  • returns Array

  var arr = [0,1,2,3,4,5,6,7,8,9];
  arr.shuffle(); // [1,3,5,2,0,6,4,7,9,8]
  arr.shuffle(); // [9,2,6,3,0,8,1,5,7,4]

• pickRandom: Takes One Of Elements In Base Array By Random
  • returns * | null

  var arr = [0,1,2,3,4,5,6,7,8,9];
  arr.pickRandom(); // 3
  arr.pickRandom(); // 8

• takeRandom: Randomly Takes One Or More Elements From Base Array
  • param Number count How Many Elements Should Be Taken?
  • returns Array

  var arr = [0,1,2,3,4,5,6,7,8,9];
  arr.takeRandom(); // [3]
  arr.takeRandom(3); // [5,7,9]

• clean: Clears All Null And Undefined Values (Keeping Boolean False Values)
  • returns Array

  var arr = [1,false,,,null,,"test"];
  arr.clean(); // [1,false,"test"]

• groupBy: Group Base Array by func Declaring Property
  • param Function|null func
  • returns Object

  var arr = [
   {a:"A",b:1},
   {a:"B",b:1},
   {a:"B",b:2},
   {a:"A",b:2},
   {a:"C",b:1}
  ];
  arr.groupBy(x => x.a); /*
   {
    A: [{a:"A",b:1}, {a:"A",b:2}],
    B: [{a:"B",b:1}, {a:"B",b:2}],
    C: [{a:"C",b:1}]
   }
  */

Date Prototypes

• isInRange: Checks Whether Base Date Is In Range Of start And end
  • param Date start
  • param Date end
  • returns Boolean

  var date1 = new Date("5 july 2020"),
    date2= new Date("11 july 2021"),
    start = new Date("1 july 2021"),
    end = new Date("10 july 2021");
  
  date1.isInRange(start, end); // true
  date1.isInRange(end, start); // true
  date2.isInRange(start, end); // false
  
  date1.isInRange(_, end); // TypeError('Start Must Be Instance Of Date')
  date1.isInRange(start, _); // TypeError('End Must Be Instance Of Date')

• addMilliseconds: Adds milliseconds To Base Date
  • param Number milliseconds
  • returns Date

  new Date("1 july 2021").addMilliseconds(864e5); // Fri Jul 02 2021 00:00:00 (864e5 Equals 24 Hours)
  new Date().addMilliseconds(_); // TypeError('Milliseconds Must Be Integer')

• addSeconds: Adds seconds To Base Date
  • param Number seconds
  • returns Date

  new Date("1 july 2021").addSeconds(3600); // Thu Jul 01 2021 01:00:00 (3600 Equals 1 Hours)
  new Date().addSeconds(_); // TypeError('Seconds Must Be Integer')

• addMinutes: Adds minutes To Base Date
  • param Number minutes
  • returns Date

  new Date("1 july 2021").addMinutes(70); // Thu Jul 01 2021 01:10:00
  new Date().addMinutes(_); // TypeError('Minutes Must Be Integer')

• addHours: Adds hours To Base Date
  • param Number hours
  • returns Date

  new Date("1 july 2021").addHours(24); // Fri Jul 02 2021 00:00:00
  new Date().addHours(_); // TypeError('Hours Must Be Integer')

• addDays: Adds days To Base Date
  • param Number days
  • returns Date

  new Date("1 july 2021").addDays(7); // Thu Jul 08 2021 00:00:00
  new Date().addDays(_); // TypeError('Days Must Be Integer')

• addMonths: Adds months To Base Date
  • param Number months
  • returns Date

  new Date("1 july 2021").addMonths(6); // Sat Jan 01 2022 00:00:00
  new Date().addMonths(_); // TypeError('Months Must Be Integer')

• addYears: Adds years To Base Date
  • param Number years
  • returns Date

  new Date("1 july 2021").addYears(4); // Tue Jul 01 2025 00:00:00
  new Date().addYears(_); // TypeError('Years Must Be Integer')

• totalMilliseconds: Calculates Total Milliseconds From Base Date Up Until Now
  • type Number

  var i = new Date();
  i.totalMilliseconds // 0
  someThingThatTakesTime();
  i.totalMilliseconds // 243785

• totalSeconds: Calculates Total Seconds From Base Date Up Until Now
  • type Number

  var i = new Date();
  i.totalSeconds // 0
  someThingThatTakesTime();
  i.totalSeconds // 243

• totalMinutes: Calculates Total Minutes From Base Date Up Until Now
  • type Number

  var i = new Date();
  i.totalMinutes // 0
  someThingThatTakesTime();
  i.totalMinutes // 4

• totalHours: Calculates Total Hours From Base Date Up Until Now
  • type Number

  /* Its Mon Jul 12 2021 19:42:23 Now */
  new Date("14 june 2000").totalHours // 184771 (Its Actually My Birthday ☺)

• totalDays: Calculates Total Days From Base Date Up Until Now
  • type Number

  /* Its Mon Jul 12 2021 Now */
  new Date("14 june 2000").totalDays // 7698

String Prototypes

• toRegexQuote: Creates Regex Object After Escaping Special Characters By Adding \ In Base String Note: Does Not Escape BackSlashes()
  • param String flag
  • returns Regex

  "(hello)".toRegexQuote(); // /\(hello\)/ (Regex)
  "[world]".toRegexQuote("g"); // /\[world\]/g (Regex)

• replaceAll: Replaces All Matching pattern In Base String With replacement
  • param RegExp | String pattern
  • param String replacement
  • returns String

  "HellABC WABCrld!".replaceAll("ABC", "o"); // "Hello World!"

• trimToEmpty: Trims All Extra Spaces From Base String
  • returns String

  "   This    is a Test!".trimToEmpty(); // "This is a Test!"
  "           ".trimToEmpty(); // ""

• trimToNull: Trims All Extra Spaces From Base String And Return Null If Nothing Remains
  • returns String|null

  "   This    is a Test!".trimToNull(); // "This is a Test!"
  "           ".trimToNull(); // null

• toEnglishNumeric: Replace All Persian Numbers In Base String With English Ones
  • returns String

  "Published In July ۲۰۲۱".toEnglishNumeric(); // "Published In July 2021"

• toPersianNumeric: Replace All English Numbers In Base String With Persian Ones
  • returns String

  "منتشر شده در ژولای 2021".toPersianNumeric(); // "منتشر شده در ژولای ۲۰۲۱"

Number Prototypes

• fixDigits: Add Leading Zero To Start(digits) And End(decimals) Of Base Number
  • param Number digits
  • param Number decimals
  • returns String

  /* Integer */
  var num = 123;
  num.fixDigits(4); // "0123"
  num.fixDigits(5); // "00123"
  
  /* Float */
  var num = 12.3;
  num.fixDigits(4); // "0012.3"
  num.fixDigits(4, 3); // "0012.300"

• isInRange: Checks Whether Base Number Is In Range Of start And end
  • param Number start
  • param Number end
  • returns Boolean

  var num = 6;
  num.isInRange(1, 10); // true
  num.isInRange(10, 1); // true
  
  num.isInRange(_, 10); // TypeError('Start Must Be Instance Of Number')
  num.isInRange(1, _); // TypeError('End Must Be Instance Of Number')

• isInteger: Checks If Base Number Is An Integer
  • type Boolean

  (6).isInteger // true
  (7.2).isInteger // false

• isPrime: Checks If Base Number Is A Primitive Number
  • type Boolean

  (-10).isPrime // false
  (0).isPrime // false
  (1.2).isPrime // false
  (1).isPrime // false
  (2).isPrime // true
  (3).isPrime // true
  (4).isPrime // false

• isEven: Checks If Base Number Is Even
  • type Boolean

  (2).isEven // true
  (3).isEven // false

• isOdd: Checks If Base Number Is Odd
  • type Boolean

  (2).isOdd // false
  (3).isOdd // true

• pow: Calculates Base Number Powered By exponent
  • param Number exponent
  • returns Number

  var num = 3;
  num.pow(2); // 9
  num.pow(4); // 81

• powBase: Calculates base Powered By Base Number
  • param Number base
  • returns Number

  var num = 3;
  num.powBase(2); // 8
  num.powBase(4); // 64

• absRound: Calculates ABS And Round Without Use of Math Object
  • returns Number

  (0.5).absRound();  // 0
  (-0.5).absRound();  // -0
  (3.2).absRound(); // 3
  (3.7).absRound(); // 3
  (-3.2).absRound(); // -3
  (-3.7).absRound(); // -3

• absFloor: Calculates ABS And Floor Without Use of Math Object
  • returns Number

  (0.5).absFloor();  // 0
  (-0.5).absFloor();  // 0
  (3.2).absFloor(); // 3
  (3.7).absFloor(); // 3
  (-3.2).absFloor(); // -3
  (-3.7).absFloor(); // -3

• floor: Calculates Floor Without Use of Math Object
  • returns Number

  (1.2).floor();  // 1
  (1.8).floor();  // 1

• ceil: Calculates Ceil Without Use of Math Object
  • returns Number

  (1.2).ceil();  // 2
  (1.8).ceil();  // 2

• round: Calculates Round Without Use of Math Object
  • returns Number

  (1.2).round();  // 1
  (1.8).round();  // 2

• sign: Calculates Sign Without Use of Math Object
  • returns Number

  (-5).sign();  // -1
  (0).sign();  // 0
  (5).sign();  // 1

• sqrt: Calculates SQRT Without Use of Math Object
  • returns Number

  (16).sqrt();  // 4

• cbrt: Calculates CBRT Without Use of Math Object
  • returns Number

  (27).cbrt();  // 3

• abs: Calculates ABS Without Use of Math Object
  • returns Number

  (27).abs();  // 27
  (-27).abs();  // 27

• trunc: Calculates Trunc Without Use of Math Object
  • returns Number

  (27.12345).trunc();  // 27
  (-27.12345).trunc();  // 27

Object Prototypes

• toFormData: Creates An Instance Of FormData From Base Object
  • returns FormData

  var akoObject = {
    id: 1,
    gender: "MALE",
    birthDate: new Date("14 june 2000"),
    avatar: document.querySelector("input[type=file]").files,
    nickNames:[
      "ako","ako-team"
    ]
  }
  var akoFormData = akoObject.toFormData(); // FormData

FormData Prototypes

• toObject: Converts FormData Object Into JS Object
  • returns Object

  /* akoFormData Is The Same As What Defined In Object Prototypes Section */
  akoFormData.toObject(); 
  /*
    {
      avatar: File { name: "blob", lastModified: 1626103627984, size: 0, … }
      birthDate: "2000-06-13T19:30:00.000Z"
      gender: "MALE"
      id: "1"
      nickNames: Array [ "ako", "ako-team" ]
    }
  */

• toJson: Converts FormData Object Into JSON
  • returns String

  /* akoFormData Is The Same As What Defined In Object Prototypes Section */
  akoFormData.toJson(); // {"avatar":{},"birthDate":"2000-06-13T19:30:00.000Z","gender":"MALE","id":"1","nickNames":["ako","ako-team"]}

Math Properties

• randomInRange: Calculates A Random Number Between startRange And endRange
  • param Number startRange Default Is 0
  • param Number endRange Default Is 1
  • returns Number

  Math.randomInRange(1, 10); // 7
  Math.randomInRange(1, 10); // 6 
  Math.randomInRange(10, 1); // 3 
  
  Math.randomInRange(5); // 1 (Between One And 5)
  Math.randomInRange(5); // 3

• randomBoolean: Creates A Random Boolean
  • returns Boolean

  Math.randomBoolean(); // true
  Math.randomBoolean(); // true
  Math.randomBoolean(); // false

Boolean Prototypes

• reverse: Reverse Base Boolean Value
  • returns Boolean

  var i = 1, b=2;
  (i > b).reverse() // true

License

MIT