Arrays and objects helper

You use arrays and objects in your project? Than ... this package may be a very handy one for you (✿◕‿◕).

How to use? Guide:

You have more functions available:

1. isArray: Check if the element passed is an array.
2. isObject: Check if the element passed is an object.
3. keys: Returns the keys of an object.
4. values: Return the values of an object.
5. sort: Sort an array or an object. Arrays of numbers are sorted ascending. Arrays of strings are sorted alphabetically. Object are sorted by keys.
6. check: A function with 2 parameters that checks if in a container(first prop that can be array or object) exist a value or a key(in addition to object). Also, it has a deep check if the property(second parameter) is an array or an object.
7. checkIfEmpty: A function that checks if a container(array or object) is empty.
8. checkAllBoolean: A function with 2 parameters that checks if in a container(first prop that can be array or object), values respect a conditionFunction(second param) or have booleans true.
9. tableHeadBodyStructure: A function that create from a container(first prop that can be array or object) a table structure object with arrays HEAD and BODY. Also, it has keysOrderArrayIndex(second parameter) that is used for an array of objects container to choose the keys order.
   See more details in the next examples.

isArray function with prop element

// isArray(element)
import { isArray } from 'arrays-and-objects';

console.log(isArray([1, 4, 2, 5])); // true
console.log(isArray(4)); // false
console.log(isArray({ 3: [4, 5, 6] })); // false

isObject function with prop element

// isObject(element)
import { isObject } from 'arrays-and-objects';

console.log(isObject([1, 4, 2, 5])); // true (javascript sees arrays as objects)
console.log(isObject(4)); // false
console.log(isObject({ 3: [4, 5, 6] })); // true

keys function with prop object

// keys(object)
import { keys } from 'arrays-and-objects';

console.log(keys({ John: true, Mary: false })); // [ 'John', 'Mary' ]
console.log(keys([1, 4, 2, 5])); // [ '0', '1', '2', '3' ]
console.log(keys({ 3: [4, 5, 6] })); // [ '3' ]
console.log(keys(1)); // Error: The parameter must be an object!

values function with prop object

// values(object)
import { values } from 'arrays-and-objects';

console.log(values({ John: true, Mary: false })); // [ true, false ]
console.log(values(true)); // Error: The parameter must be an object!
console.log(values([1, 4, 2, 5])); // [ 1, 4, 2, 5 ]
console.log(values({ 3: [4, 5, 6], 1: [7] })); // [ [ 7 ], [ 4, 5, 6 ] ]

sort function with prop object or array (container)

// sort(container)
import { sort } from 'arrays-and-objects';

console.log(sort({ Noah: false, John: true, Mary: false })); // { John: true, Mary: false, Noah: false }
console.log(sort(true)); // Error: You can sort only arrays and objects(by keys).
console.log(sort([1, 4, 2, 5])); // [ 1, 2, 4, 5 ]
console.log(sort({ 3: [8, 1, 3], 1: [7] })); // { '1': [ 7 ], '3': [ 8, 1, 3 ] }

check function with the first prop a container and the second prop an property needed to be checked

// check(container,property)
import { check } from 'arrays-and-objects';

console.log(
  check(
    [
      {
        User: ['Mark'],
        Access: { HomePage: true, People: ['Johanna', 'Sim'] },
      },
      'Noah',
      'Michelle',
    ],
    {
      Access: { People: ['Sim', 'Johanna'], HomePage: true },
      User: ['Mark'],
    }
  )
); // true, because every array and object is sorted

console.log(
  check(
    [
      'Madagascar',
      [
        'Toliara',
        'Antananarivo',
        {
          Capital: 'Antananarivo',
          Others: [
            'largest island in the world',
            'official',
            { Currency: ['Malagasy ariary', true], Population: 26.26 },
          ],
          Language: 'Malagasy',
        },
      ],
    ],
    [
      'Antananarivo',
      'Toliara',
      {
        Language: 'Malagasy',
        Capital: 'Antananarivo',
        Others: [
          { Population: 26.26, Currency: ['Malagasy ariary', true] },
          'official',
          'largest island in the world',
        ],
      },
    ]
  )
); // true

console.log(
  check(
    [
      'Products',
      [
        'rice',
        'oil',
        {
          vitamin: 'A',
          locations: [
            'Mali',
            'Ecuador',
            { Important: 1, Capital: ['Quito', true] },
          ],
        },
      ],
    ],
    1
  )
); // false, you cannot check deep inner values

console.log(
  check(
    {
      Nr: 1,
      State: ['Alabama', 'Mexico'],
    },
    'State'
  )
); // true

console.log(check('State')); // Error: The first prop needs to be an array or an object. This is the container in which you look for a property.
console.log(check()); // Error: The first prop is a container(array/object) and the second prop the property(value or key/value if container is an object) the container has. Please make sure to fill both.

checkIfEmpty function with prop container

// checkIfEmpty(container)
import { checkIfEmpty } from 'arrays-and-objects';

console.log(checkIfEmpty('Table')); //Error: Please provide an object or an array.
console.log(checkIfEmpty({ Name: '', Age: '' })); // false
console.log(checkIfEmpty({ Name: 'John', Age: 23542 })); // false
console.log(checkIfEmpty({})); // true

checkAllBoolean function with props container and conditionFunction

// checkAllBoolean(container,conditionFunction)
import { checkAllBoolean } from 'arrays-and-objects';

console.log(checkAllBoolean('Table')); //Error: Please provide an object or an array.
console.log(
  checkAllBoolean(
    [
      { NAME: 'John', AGE: 45 },
      { NAME: 'Mary', AGE: 25 },
    ],
    person => person.AGE >= 26
  )
); // false
console.log(
  checkAllBoolean(
    [
      { NAME: 'John', AGE: 45 },
      { NAME: 'Mary', AGE: 26 },
    ],
    person => person.AGE >= 26
  )
); // true

tableHeadBodyStructure function with props container and keysOrderArrayIndex

// tableHeadBodyStructure(container,keysOrderArrayIndex)
import { tableHeadBodyStructure } from 'arrays-and-objects';

console.log(tableHeadBodyStructure('Table')); // Error: Please provide an object or an array with elements.
console.log(tableHeadBodyStructure()); // Error: Please provide an object or an array with elements.
console.log(tableHeadBodyStructure({})); // Error: Please provide an object or an array with elements.
console.log(tableHeadBodyStructure([123, 324, 34, 3])); //{ HEAD: [ '0', '1', '2', '3' ], BODY: [ 123, 324, 34, 3 ] }
console.log(
  tableHeadBodyStructure({
    John: { AGE: 45, PROFILE: 'Active' },
    Lucas: { AGE: 38, PROFILE: 'Inactive' },
    Mary: { AGE: 35, PROFILE: 'Active' },
  })
);
// {
//   HEAD: [ 'John', 'Lucas', 'Mary' ],
//   BODY: [
//     { AGE: 45, PROFILE: 'Active' },
//     { AGE: 38, PROFILE: 'Inactive' },
//     { AGE: 35, PROFILE: 'Active' }
//   ]
// }
console.log(
  tableHeadBodyStructure([
    { NAME: 'John', AGE: 45, PROFILE: 'Active' },
    { AGE: 38, PROFILE: 'Inactive', NAME: 'Lucas' },
    { NAME: 'Mary', PROFILE: 'Active', AGE: 35 },
  ])
);
// {
//   HEAD: [ 'NAME', 'AGE', 'PROFILE' ],
//   BODY: [
//     [ 'John', 45, 'Active' ],
//     [ 'Lucas', 38, 'Inactive' ],
//     [ 'Mary', 35, 'Active' ]
//   ]
// }
console.log(
  tableHeadBodyStructure(
    [
      { NAME: 'John', AGE: 45, PROFILE: 'Active' },
      { AGE: 38, PROFILE: 'Inactive', NAME: 'Lucas' },
      { PROFILE: 'Active', NAME: 'Mary', AGE: 35 },
    ],
    2
  )
);
// {
//   HEAD: [ 'PROFILE', 'NAME', 'AGE' ],
//   BODY: [
//     [ 'Active', 'John', 45 ],
//     [ 'Inactive', 'Lucas', 38 ],
//     [ 'Active', 'Mary', 35 ]
//   ]
// }
console.log(tableHeadBodyStructure({ NAME: 'John', AGE: 45, PROFILE: 'Active' }));
// { HEAD: [ 'NAME', 'AGE', 'PROFILE' ], BODY: [ 'John', 45, 'Active' ] }

If you encounter any error, or you have suggestions to improve this pack with more functions, don't hesitate to write me on [email protected] ^_^.