1.0.1 • Published 5 years ago

jsonarraytools v1.0.1

Weekly downloads
2
License
MIT
Repository
-
Last release
5 years ago

JSON Tools

Easy to use functions for handling JSON objects and arrays. Documentation provided below.

isArrayEqualToValue

Arguments: (array, value)

require("jsonarraytools").isArrayEqualToValue(["foo", "foo"], "foo"); 
require("jsonarraytools").isArrayEqualToValue(["foo", "bar"], "bar");

Response

true
false

isArrayEqual

Arguments: (arrays...)

require("jsonarraytools").isArrayEqual([1, 1, 1, 1]);
require("jsonarraytools").isArrayEqual([1, 2, 3, 4]);

Response

true
false

checkArrayByCriteria

Arguments: (array, criteria)

require("jsonarraytools").checkArrayByCriteria([10, 20, 30], v => v > 25);
require("jsonarraytools").checkArrayByCriteria([10, 20, 30], v => v > 100);

Response

true
false

arrayIsNotEmpty

Arguments: (arrays...)

require("jsonarraytools").arrayIsNotEmpty([1, 2, 3]);
require("jsonarraytools").arrayIsNotEmpty([]);

Response

true
false

isArraySubset

Arguments: (arrays...)

require("jsonarraytools").isArraySubset([1, 2], [1, 3, 2]);
require("jsonarraytools").isArraySubset([1, 2, 5], [1, 2, 3 ,4]);

Response

true
false

isArray

Arguments: (array)

require("jsonarraytools").isArray(["1"]);
require("jsonarraytools").isArray({ "1": "1" });

Response

true
false

compareArrays

Arguments: (arrays...)

require("jsonarraytools").compareArrays([1, 2, 3], [3, 1, 2]);
require("jsonarraytools").compareArrays([1, 2, 3], [1, "2", 3]);

Response

true
false

convertArrayToObject

Arguments: (array, key)

require("jsonarraytools").convertArrayToObject([{ name: "Michael", email: "michael.scott@dundermifflin.com", password: "ilovehollyflax"}, { name: "Toby", email: "toby.flenderson@dundermufflin.com", password: "whydoesnooneloveme"}], "email");

Response

{
	"michael.scott@dundermufflin.com": {
		name: "Michael",
		email: "michael.scott@dundermifflin.com",
		password: "ilovehollyflax"
	},
	"toby.flenderson@dundermufflin.com": {
		name: "Toby",
		email: "toby.flenderson@dundermufflin.com",
		password: "whydoesnooneloveme"
	}
}

convertArrayOfStringsToNumber

Arguments: (array)

require("jsonarraytools").convertArrayOfStringsToNumber(["2", "3", "4"]);

Response

[ 2, 3, 4 ]

createCumulativeArray

Arguments: (array)

require("jsonarraytools").createCumulativeArray([1, 2, 3]);

Response

[ 1, 3, 6 ]

createArrayInRange

Arguments: (min, max)

require("jsonarraytools").createArrayInRange(0, 10);

Response

[ 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10 ]

emptyArray

let array = ["1", "2"];
console.log(array);
array = require("jsonarraytools").emptyArray(array);
console.log(array)

Response

["1", "2"]
[]

closetNumberToValue

Arguments: (array, number)

require("jsonarraytools").closetNumberToValue([10, 20, 30], 12); 

Response

10

findLongestString

Arguments: (array)

require("jsonarraytools").findLongestString(["find", "the", "longest", "string"]); 

Response

7

findMaxItemInArray

Arguments: (array)

require("jsonarraytools").findMaxItemInArray([1, 100])

Response

100

findMinItemInArray

Arguments: (array)

require("jsonarraytools").findMinItemInArray([1, 100])

Response

1

flattenArray

Arguments: (array[array])

require("jsonarraytools").flattenArray(["Dwight", ["Jim", "Pam"]]);

Response

["Dwight", "Jim", "Pam"]

randomArrayInRange

Arguments: (min, max, amount)

require("jsonarraytools").randomArrayInRange(0, 100, 2);

Response

returns 2 random numbers in range 0-100

randomItemFromArray

Arguments: (array)

require("jsonarraytools").randomItemFromArray([1, 2, 3]);

Response

1 || 2 || 3

getAverageOfArray

Arguments: (array)

require("jsonarraytools").getAverageOfArray([1, 2, 3]);

Response

2

getIntersectionOfArray

Arguments: (arrays...)

require("jsonarraytools").getIntersectionOfArray([1, 3], [2, 3, 4], [3]);

Response

3

getSumOfArray

Arguments: (array)

require("jsonarraytools").getSumOfArray([1, 2])

Response

3

getUniqueValuesOfArray

Arguments: (array)

require("jsonarraytools").getUniqueValuesOfArray([1, 1, 2]);

Response

1

getUnionOfArrays

Arguments: (arrays...)

require("jsonarraytools").getUnionOfArrays([1, 2], [2, 1]);

Response

[1, 2]

mergeArrays

Arguments: (array...)

require("jsonarraytools").mergeArrays([1], [2]);

Response

[ 1, 2 ]

partitionArrayOnCondition

Arguments: (array, condition)

require("jsonarraytools").partitionArrayOnCondition([1, 2, 3, 4, 5], n => n > 2);

Response

[ [ 3, 4, 5 ], [ 1, 2] ]

removeFalsyValues

Arguments: (array)

require("jsonarraytools").removeFalsyValues([0, "string", NaN]);

Response

[ "string" ]

shuffleArray

Arguments: (array)

require("jsonarraytools").shuffleArray([1, 2, 3, 4]);

Response

[ 3, 2, 1, 4 ]

sortArrayOfNumbers

Arguments: (array)

require("jsonarraytools").sortArrayOfNumbers([1, 5, 10, 7, 3]);

Response

[ 1, 3, 5, 7, 10 ]

splitArrayIntoChunks

Arguments: (array, chunks)

require("jsonarraytools").splitArrayIntoChunks([1, 2, 3, 4], 1));

Response

[ [ 1 ], [ 2 ], [ 3 ], [ 4 ] ]

tranposeMatrix

Arguments: (arrays...)

require("jsonarraytools").tranposeMatrix([1, 2, 3], [4, 5, 6], [7, 8, 9]);

Response

[ [1, 4, 7], [ 2, 5, 8 ], [ 3, 6, 9 ] ]

unzipArrayOfArrays

Arguments: (arrays...)

require("jsonarraytools").unzipArrayOfArrays([["a", 1], ["b", 2], ["c", 3]]);

Response

[ [ "a", "b", "c"], [ 1, 2, 3 ] ]

zipArrayOfArrays

Arguments: (arrays...)

require("jsonarraytools").zipArrayOfArrays(["a", "b", "c"], [1, 2, 3]);

Response

[ [ "a", 1 ], [ "b", 2 ], [ "c", 3 ] ]

isPlainObject

Arguments: (object)

require("jsonarraytools").isPlainObject({ a: "1"});
require("jsonarraytools").isPlainObject(null);

Response

true
false

isObject

Arguments: (object)

require("jsonarraytools").isObject({});
require("jsonarraytools").isObject(null);

Response

true
false

isObjectEmpty

Arguments: (object)

require("jsonarraytools").isObjectEmpty({});
require("jsonarraytools").isObjectEmpty({ "": "" });

Response

true
false

isObjectEqual

Arguments: (object1, object2)

require("jsonarraytools").isObjectEqual({ foo: "bar"}, { foo: "bar" });
require("jsonarraytools").isObjectEqual({ foo: "bar"}, { bar: "foo" });

Response

true
false

arrayToObject

Arguments: (arrays...)

require("jsonarraytools").arrayToObject([["a", 1], ["b", 2]]);

Response

{ a: 1, b: 2 }

ExtractValueFromObject

Arguments: (array of objects)

require("jsonarraytools").ExtractValueFromObject([{ name: "Toby", loveable: false }, { name: "Michael", loveable: true }], "name");

Response

[ "Toby", "Michael" ]

getValueOfPath

Arguments: (path, objects)

require("jsonarraytools").getValueOfPath("foo.bar", { foo: { bar: "hello world" } });

Response

hello world

invertKeysOfObject

Arguments: (object)

require("jsonarraytools").invertKeysOfObject({ a: "1", b: "2" });

Response

{ 1: "a", 2: "b" }

OmitSubsetPropFromObject

Arguments: (object, prop)

require("jsonarraytools").OmitSubsetPropFromObject({ a: "1", b: "2" }, ["a"]);

Response

{ b: "2" }

PickSubsetPropFromObject

Arguments: (object, prop)

require("jsonarraytools").PickSubsetPropFromObject({ a: "1", b: "2" }, ["a"]);

Response

{ a: "1" }
1.0.1

5 years ago

1.0.0

5 years ago

0.0.1

5 years ago