Skip to content

Commit 262e262

Browse files
author
Steve Thompson
committed
more changes to README
1 parent ca5d3c8 commit 262e262

File tree

1 file changed

+29
-32
lines changed

1 file changed

+29
-32
lines changed

README.md

Lines changed: 29 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -34,10 +34,7 @@ var getPublicArray = require('@writetome51/public-array').getPublicArray;
3434
```
3535

3636

37-
## Public API
38-
39-
40-
### Instantiation
37+
## Instantiation
4138
```
4239
getPublicArray(array = []): PublicArray
4340
// Examples:
@@ -46,24 +43,24 @@ getPublicArray(array = []): PublicArray
4643
// let arr = getPublicArray();
4744
```
4845

49-
### Properties
46+
## Properties
5047

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.
5350

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
5653

57-
#### length: number (read-writable)
58-
###### length of array
54+
### length: number (read-writable)
55+
##### length of array
5956

60-
#### isEmpty: boolean (read-only)
61-
###### true if this.data is empty
57+
### isEmpty: boolean (read-only)
58+
##### true if this.data is empty
6259

63-
#### notEmpty: boolean (read-only)
60+
### notEmpty: boolean (read-only)
6461

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:
6764
<details>
6865
<summary>view methods</summary>
6966

@@ -79,8 +76,8 @@ filter.byType(
7976
</details>
8077

8178

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.
8481
<details>
8582
<summary>view methods</summary>
8683

@@ -95,8 +92,8 @@ getConverted.each(mappingFunction: ((item, index?, array?) => any)): any[]
9592
```
9693
</details>
9794

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.
10097
<details>
10198
<summary>view methods</summary>
10299

@@ -177,8 +174,8 @@ get.byType(
177174
</details>
178175

179176

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:
182179
<details>
183180
<summary>view methods</summary>
184181

@@ -254,8 +251,8 @@ getAndRemove.byType(
254251
</details>
255252

256253

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:
259256
<details>
260257
<summary>view methods</summary>
261258

@@ -272,8 +269,8 @@ insert.middle(values: any[], offset = 0): PublicArrayInserter
272269
</details>
273270

274271

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:
277274
<details>
278275
<summary>view methods</summary>
279276

@@ -356,8 +353,8 @@ remove.byType(
356353
</details>
357354

358355

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:
361358
<details>
362359
<summary>view methods</summary>
363360

@@ -431,8 +428,8 @@ replace.allWithOne(values: any[], newValue): PublicArrayReplacer
431428
</details>
432429

433430

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:
436433
<details>
437434
<summary>view methods</summary>
438435

@@ -454,10 +451,10 @@ sort.shuffle(): PublicArraySorter;
454451
</details>
455452

456453

457-
#### className: string (read-only)
454+
### className: string (read-only)
458455

459456

460-
### Methods
457+
## Methods
461458
<details>
462459
<summary>view methods</summary>
463460

0 commit comments

Comments
 (0)