@@ -34,10 +34,7 @@ var getPublicArray = require('@writetome51/public-array').getPublicArray;
34
34
```
35
35
36
36
37
- ## Public API
38
-
39
-
40
- ### Instantiation
37
+ ## Instantiation
41
38
```
42
39
getPublicArray(array = []): PublicArray
43
40
// Examples:
@@ -46,24 +43,24 @@ getPublicArray(array = []): PublicArray
46
43
// let arr = getPublicArray();
47
44
```
48
45
49
- ### Properties
46
+ ## Properties
50
47
51
- #### data: any[ ] (read-writable)
52
- ###### This is the array to be operated on.
48
+ ### data: any[ ] (read-writable)
49
+ ##### This is the array to be operated on.
53
50
54
- #### copy: PublicArray (read-only)
55
- ###### an independent copy of the PublicArray instance
51
+ ### copy: PublicArray (read-only)
52
+ ##### an independent copy of the PublicArray instance
56
53
57
- #### length: number (read-writable)
58
- ###### length of array
54
+ ### length: number (read-writable)
55
+ ##### length of array
59
56
60
- #### isEmpty: boolean (read-only)
61
- ###### true if this.data is empty
57
+ ### isEmpty: boolean (read-only)
58
+ ##### true if this.data is empty
62
59
63
- #### notEmpty: boolean (read-only)
60
+ ### notEmpty: boolean (read-only)
64
61
65
- #### filter: PublicArrayFilter (read-only)
66
- ###### Has methods that narrow down the content of the array and return the PublicArrayFilter instance:
62
+ ### filter: PublicArrayFilter (read-only)
63
+ ##### Has methods that narrow down the content of the array and return the PublicArrayFilter instance:
67
64
<details >
68
65
<summary >view methods</summary >
69
66
@@ -79,8 +76,8 @@ filter.byType(
79
76
</details >
80
77
81
78
82
- #### getConverted: PublicArrayGetterConverter (read-only)
83
- ###### Has the Array methods .map() and .reduce() , but renamed to .each() and .toOne() , respectively. None of them modify the array.
79
+ ### getConverted: PublicArrayGetterConverter (read-only)
80
+ ##### Has the Array methods .map() and .reduce() , but renamed to .each() and .toOne() , respectively. None of them modify the array.
84
81
<details >
85
82
<summary >view methods</summary >
86
83
@@ -95,8 +92,8 @@ getConverted.each(mappingFunction: ((item, index?, array?) => any)): any[]
95
92
```
96
93
</details >
97
94
98
- #### get: PublicArrayGetter (read-only)
99
- ###### Has methods that return items copied from the array. None of them modify the array.
95
+ ### get: PublicArrayGetter (read-only)
96
+ ##### Has methods that return items copied from the array. None of them modify the array.
100
97
<details >
101
98
<summary >view methods</summary >
102
99
@@ -177,8 +174,8 @@ get.byType(
177
174
</details >
178
175
179
176
180
- #### getAndRemove: PublicArrayGetterRemover (read-only)
181
- ###### Has methods that both remove and return items from the array:
177
+ ### getAndRemove: PublicArrayGetterRemover (read-only)
178
+ ##### Has methods that both remove and return items from the array:
182
179
<details >
183
180
<summary >view methods</summary >
184
181
@@ -254,8 +251,8 @@ getAndRemove.byType(
254
251
</details >
255
252
256
253
257
- #### insert: PublicArrayInserter (read-only)
258
- ###### Has methods that increase the length of the array and return the PublicArrayInserter instance:
254
+ ### insert: PublicArrayInserter (read-only)
255
+ ##### Has methods that increase the length of the array and return the PublicArrayInserter instance:
259
256
<details >
260
257
<summary >view methods</summary >
261
258
@@ -272,8 +269,8 @@ insert.middle(values: any[], offset = 0): PublicArrayInserter
272
269
</details >
273
270
274
271
275
- #### remove: PublicArrayRemover (read-only)
276
- ###### Has methods that all remove items from the array and return the PublicArrayRemover instance:
272
+ ### remove: PublicArrayRemover (read-only)
273
+ ##### Has methods that all remove items from the array and return the PublicArrayRemover instance:
277
274
<details >
278
275
<summary >view methods</summary >
279
276
@@ -356,8 +353,8 @@ remove.byType(
356
353
</details >
357
354
358
355
359
- #### replace: PublicArrayReplacer (read-only)
360
- ###### Has methods that all replace items in the array and return the PublicArrayReplacer instance:
356
+ ### replace: PublicArrayReplacer (read-only)
357
+ ##### Has methods that all replace items in the array and return the PublicArrayReplacer instance:
361
358
<details >
362
359
<summary >view methods</summary >
363
360
@@ -431,8 +428,8 @@ replace.allWithOne(values: any[], newValue): PublicArrayReplacer
431
428
</details >
432
429
433
430
434
- #### sort: PublicArraySorter (read-only)
435
- ###### Has methods that change the order of the items and return the PublicArraySorter instance:
431
+ ### sort: PublicArraySorter (read-only)
432
+ ##### Has methods that change the order of the items and return the PublicArraySorter instance:
436
433
<details >
437
434
<summary >view methods</summary >
438
435
@@ -454,10 +451,10 @@ sort.shuffle(): PublicArraySorter;
454
451
</details >
455
452
456
453
457
- #### className: string (read-only)
454
+ ### className: string (read-only)
458
455
459
456
460
- ### Methods
457
+ ## Methods
461
458
<details >
462
459
<summary >view methods</summary >
463
460
0 commit comments