Canine JS

Canine JS is a Javascript helper library with functions to make programming in js easy.

Getting Started

Install using npm

npm i caninejs

Available Methods.

• getType
• compare
• compareObjects
• compareMaps
• compareArrays
• unique
• uniqueObjects
• uniqueMaps

getType

getType accepts an element as input and returns the type of the element as output.

Syntax: getType(value);

• value: It can be String, Number, Boolean, Object, Array, Map, Set.

import { getType } from 'caninejs';

var x = { x: 1 };
var y = ['1', { x: 1 }, [], 'apple'];
var z = 'caninejs';
var a = new Map();
var b = new Error();
var c = new WeakSet();

getType(x); // returns "object"
getType(y); // returns "array"
getType(z); // returns "string"
getType(a); // returns "map"
getType(b); // returns "error"
getType(c); // returns "weakset"

compare

compare accepts two elements as input and returns true if they are equal else it will return false.

Syntax: compare(valueOne, valueTwo);

• valueOne: value to be compared.
• valueTwo: value to be compared. (Values can be Strings, Numbers, Boolean, Objects, Arrays, Maps & Sets)

import { compare } from 'caninejs';

var x = [1, 'test', 'a', {}];
var y = { b: 2, a: 1, c: { b: 1, z: ['test2']} };
var z = { a: 1, b: 2, c: { b: 1, z: ['test2']} };

compareObjects(x, y); // returns false
compareObjects(y, z); // returns true
compareObjects(x, z); // returns false

compareObjects

compareObjects accepts two Objects as input and returns true if they are equal else it will return false. It will also return false if any of the input is not an Object.

Syntax: compareObjects(objectOne, objectTwo);

• objectOne: Object to be compared.
• objectTwo: Object to be compared.

import { compareObjects } from 'caninejs';

var x = { a: 1, b: 2, c: { b: 1, z: ['test']} };
var y = { b: 2, a: 1, c: { b: 1, z: ['test2']} };
var z = { a: 1, b: 2, c: { b: 1, z: ['test2']} };

compareObjects(x, y); // returns false
compareObjects(y, z); // returns true
compareObjects(x, z); // returns false

compareMaps

compareMaps accepts two Maps as input and returns true if they are equal else it will return false. It will also return false if any of the input is not a Map.

Syntax: compareMaps(mapOne, mapTwo);

• mapOne: Map to be compared.
• mapTwo: Map to be compared.

import { compareMaps } from 'caninejs';

var x = new Map();
var y = new Map([['a', 'test']]);
var z = new Map([['a', 'test']]);

compareMaps(x, y); // returns false
compareMaps(y, z); // returns true
compareMaps(x, z); // returns false

compareArrays

compareArrays accept two Arrays as input and returns true if they are equal else it will return false. It will also return false if any of the input is not an Array.

Syntax: compareArrays(arrayOne, arrayTwo, shouldSort);

• arrayOne: Array to be compared.
• arrayTwo: Array to be compared.
• shouldSort: Boolean value denoting weather the array should be sorted before comparision. If true the array will be sorted, if false it won't be sorted. By default shouldSort is false.

import { compareArrays } from 'caninejs';

var x = [1, 'a', 'test', {}];
var y = [1, 'test', 'a', {}];
var z = [1, 'test', 'a', {}];

compareArrays(x, y); // returns false;
compareArrays(y, z); // returns true;
compareArrays(x, z); // returns false;

compareArrays will also accept a third boolean input, which is false by default. If true, the arrays will be compared even if they are ordered differently (Result will be true even if the arrays have same values but in different order). If false or left empty, the result will be false for similar arrays with same values in different order.

import { compareArrays } from 'caninejs';

var x = [{ x: '10' }, 1, [1, 'x', 0], 'a'];
var y = [1, [1, 'x', 0], 'a', { x: '10'}];

compareArrays(x, y, true); // returns true;
compareArrays(x, y, false); // returns false;
compareArrays(x, y); // returns false;

unique

unique accepts an array as input, filters all non-unique values in the array and gives the resultant array as output. If the input is array of objects or array of maps, then it's filtered based on a key.

Syntax: unique(array, isSorted, key)

• array: Array.
• isSorted: Boolean. (if the array is already sorted, give true. If this is false, the array will be sorted before unique operation)
• key: String with key which should be used to filter unique values in array of objects or array of maps.

import { unique } from 'caninejs';

var x = [7, 5, 3, 7, 6, 8, 6, 9, 0];
var y = [0, 3, 5, 6, 6, 7, 7, 8, 9];
var z = [{ id: 1, name: 'krishna' }, { id: 2, name: 'prasanth' }, { id: 1, name: 'krishna'}];

unique(x); // returns [0, 1, 4, 5, 7, 8, 9]
unique(x, false); // returns [0, 1, 4, 5, 7, 8, 9]
unique(y, true); // returns [0, 3, 5, 6, 7, 8, 9]
unique(z, true, 'id'); // returns [{ id: 1, name: 'krishna' }, { id: 2, name: 'prasanth' }]

uniqueObjects

uniqueObjects accepts an array of objects as input, filters if given key has similar values.

Syntax: unique(array, isSorted, key)

• value: Array.
• isSorted: Boolean. (if the array is already sorted, give true. If this is false, the array will be sorted before unique operation)
• key: String with key which should be used to filter unique values.

import { uniqueObjects } from 'caninejs';

var x = [7, 5, 3, 7, 6, 8, 6, 9, 0];
var y = [0, 3, 5, 6, 6, 7, 7, 8, 9];
var z = [{ id: 1, name: 'krishna' }, { id: 2, name: 'prasanth' }, { id: 1, name: 'krishna'}];

uniqueObjects(z, true, 'id'); // returns [{ id: 1, name: 'krishna' }, { id: 2, name: 'prasanth' }]

uniqueMaps

uniqueMaps accepts an array of maps as input, filters if given key has similar values.

Syntax: unique(array, isSorted, key)

• value: Array.
• isSorted: Boolean. (if the array is already sorted, give true. If this is false, the array will be sorted before unique operation)
• key: String with key which should be used to filter unique values.

import { uniqueMaps } from 'caninejs';

var map1 = new Map();
map1.set('id', 1);
map1.set('name', 'krishna');

var map2 = new Map();
map2.set('id', 2);
map2.set('name', 'thamizh');

var map3 = new Map();
map3.set('id', 1);
map3.set('name', 'krishna');

var z = [map1, map2, map3];

uniqueMaps(z, true, 'id'); // returns [map1, map2]

License

MIT

Contributors

Thanks goes to these wonderful people (emoji key):

This project follows the all-contributors specification. Contributions of any kind welcome!