deep-iterall

deep-iterall is a module that helps you to iterate every technically iterable thing deeply.

• Work with Objects, Arrays and Array-likes variables

• Accepts middleware to manage the returned result

• Accepts Map, Set and NodeList collections besides Arrays and Objects

Installation

For yarn

1yarn add deep-iterall

For npm

1npm  install --save  deep-iterall

Importing to the Project

1const  DeepIterall = require('deep-iterall');

or you use ES6 import

1import  DeepIterall  from  'deep-iterall';

Usage

Basically DeepIterall is a class that return an instance to do the job. So, create an instance from this class

Example

1
2const  illinoisUniversities = [
3{
4university:  "Eastern Illinois University",
5city:  "Charleston",
6state:  "Illinois",
7established:  "1895",
8departments: [
9	{
10		id:  "0",
11		name:  "Business and Technology",
12		places: { arena:  "Lartz Arena", stadium:  "O'Brien stadium" },
13		areas: ["School of Business", "Hospitality and Tourism", "School of Technology"]
14	}]
15}
16//....
17]
18
19const deeplyIteratedCollection = new DeepIterall(illinoisUniversities);
20
21console.log(deeplyIteratedCollection.run())
22/*
23 [
24 'university',
25  'city',
26  'state',
27  'established',
28  'departments',
29  'id',
30  'name',
31  'places',
32  'arena',
33  'stadium',
34  'areas',
35  'School of Business',
36  'Hospitality and Tourism',
37  'Technology, School of' ]
38*/
39  
40

Options

• objectValues : Default false , Return an object's key with its value as an object that iterating at the time
• excludeObjectKeysWithIterableValue Default true , Result won't include the object keys that their values are iterable elements

1const  iterator = new  DeepIterall(usaUniversities, { objectValues: true });
2/*
3[ { university: 'Eastern Illinois University' },
4  { city: 'Charleston' },
5  { state: 'Illinois' },
6  { established: '1895' },
7  { id: '0' },
8  { name: 'Business and Technology' },
9  { arena: 'Lartz Arena' },
10  { stadium: 'O\'Brien stadium' },
11  'School of Business',
12  'Hospitality and Tourism',
13  'Technology, School of' ]
14*/
15
16  
17  const  iterator = new  DeepIterall(usaUniversities, { excludeObjectKeysWithIterableValue: false });
18/*
19[ 'university',
20  'city',
21  'state',
22  'established',
23  'id',
24  'name',
25  'arena',
26  'stadium',
27  'School of Business',
28  'Hospitality and Tourism',
29  'Technology, School of' ]
30*/

Methods

run()

Run the whole iteration.

addContent(content) content: Array

Add new content to existing content. (this won't delete the previous content)

1    const deeplyIteratedCollection = new DeepIterall(illinoisUniversities);
2	deeplyIteratedCollection.addContent(anotherStateUniversitiesArray)

addMiddleware(middleware) middleware: Array of middlewares or Middleware

Add one ore more middleware function to manage returnet elemetns.

1    deeplyIteratedCollection.addMiddleware(lodash.upperCase)
2    /*
3    [ 'UNIVERSITY',
4	  'CITY',
5	  'STATE',
6	  'ESTABLISHED',
7	  'ID',
8	  'NAME',
9	  'ARENA',
10	  'STADIUM',
11	  'SCHOOL OF BUSINESS',
12	  'HOSPITALITY AND TOURISM',
13	  'TECHNOLOGY SCHOOL OF' ]
14	*/
15

Todos

• Write Tests

• Add Async mode

License

• MIT license

Credits

I used @leebyron's iterall package for iterate Arrays and Array-like elements (Maps, NodeLists). So I thank him to creating iterall