More changes to README

Author: Steve Thompson

README.md

@@ -54,6 +54,15 @@ arr.data = [1,2,3,4,5,6,7];
 
 ```
 
+## Performance
+
+PublicArray has a large number of dependencies.  You should keep this in mind when optimizing the 
+performance of your app. If your code only uses one property of PublicArray, like for 
+instance .replace, you will get a slight performance boost if you just use an instance of
+PublicArrayReplacer instead:
+```
+let replace = new PublicArrayReplacer(arr);
+```
 
 ## License
 [MIT](https://choosealicense.com/licenses/mit/)

dist/privy/PublicArray.d.ts

@@ -10,7 +10,8 @@ import { PublicArrayFilter } from '@writetome51/public-array-filter';
 
 
 /**************
- This class is called PublicArray because an array is contained inside it, in a public property.
+ This class is called PublicArray because an array is contained inside it,
+ in a public property: 'data'
 
  The main reason you would use this class is if you hate JavaScript's built-in Array
  methods, like .slice(), .splice(), .push(), and .shift().  This class has much clearer
@@ -21,9 +22,9 @@ import { PublicArrayFilter } from '@writetome51/public-array-filter';
  let arr = getPublicArray( [1,2,3,4,5,6] );
  arr.remove.tail(2); // arr.data is now [1,2,3,4]
  if (arr.notEmpty) arr.prepend([10]); // arr.data is now [10,1,2,3,4]
-
- To access the array itself, you access the 'data' property.
  *************/
+
+
 export declare class PublicArray extends PublicArrayContent {
 
 	private _filter;
@@ -36,7 +37,23 @@ export declare class PublicArray extends PublicArrayContent {
 	private _sort;
 
 
+	/***************
+	 Public Properties:
+
+	 readonly copy: PublicArray; // independent copy of this instance.
+	 readonly filter: PublicArrayFilter;
+	 readonly getConverted: PublicArrayGetterConverter;
+	 readonly get: PublicArrayGetter;
+	 readonly getAndRemove: PublicArrayGetterRemover;
+	 readonly insert: PublicArrayInserter;
+	 readonly remove: PublicArrayRemover;
+	 readonly replace: PublicArrayReplacer;
+	 readonly sort: PublicArraySorter;
+	 ***************/
+
+
 	constructor(
+		// begin injected dependencies...
 		_filter: PublicArrayFilter,
 		_getConverted: PublicArrayGetterConverter,
 		_get: PublicArrayGetter,
@@ -45,29 +62,21 @@ export declare class PublicArray extends PublicArrayContent {
 		_remove: PublicArrayRemover,
 		_replace: PublicArrayReplacer,
 		_sort: PublicArraySorter,
+		// ... end injected dependencies
 
-		// The actual array:
+		// the actual array:
 		data?: any[]
 	);
 
 
-	readonly filter: PublicArrayFilter;
-	readonly getConverted: PublicArrayGetterConverter;
-	readonly get: PublicArrayGetter;
-	readonly getAndRemove: PublicArrayGetterRemover;
-	readonly insert: PublicArrayInserter;
-	readonly remove: PublicArrayRemover;
-	readonly replace: PublicArrayReplacer;
-	readonly sort: PublicArraySorter;
 	readonly copy: PublicArray;
 
 
-
 	append(values: any[]): this;
 
 
 	prepend(values: any[]): this;
 
 
-	forEach(iterationFunction: Function): this;
+	forEach(iterationFunction: any): this;
 }

dist/privy/PublicArray.js

@@ -17,7 +17,8 @@ var array_append_prepend_1 = require("@writetome51/array-append-prepend");
 var di_factory_1 = require("@writetome51/di-factory");
 var public_array_content_1 = require("@writetome51/public-array-content");
 /**************
- This class is called PublicArray because an array is contained inside it, in a public property.
+ This class is called PublicArray because an array is contained inside it,
+ in a public property: 'data'
 
  The main reason you would use this class is if you hate JavaScript's built-in Array
  methods, like .slice(), .splice(), .push(), and .shift().  This class has much clearer
@@ -28,16 +29,28 @@ var public_array_content_1 = require("@writetome51/public-array-content");
  let arr = getPublicArray( [1,2,3,4,5,6] );
  arr.remove.tail(2); // arr.data is now [1,2,3,4]
  if (arr.notEmpty) arr.prepend([10]); // arr.data is now [10,1,2,3,4]
-
- To access the array itself, you access the 'data' property.
  *************/
 var PublicArray = /** @class */ (function (_super) {
     __extends(PublicArray, _super);
+    /***************
+     Public Properties:
+
+     readonly copy: PublicArray; // independent copy of this instance.
+     readonly filter: PublicArrayFilter;
+     readonly getConverted: PublicArrayGetterConverter;
+     readonly get: PublicArrayGetter;
+     readonly getAndRemove: PublicArrayGetterRemover;
+     readonly insert: PublicArrayInserter;
+     readonly remove: PublicArrayRemover;
+     readonly replace: PublicArrayReplacer;
+     readonly sort: PublicArraySorter;
+     ***************/
     function PublicArray(
     // begin injected dependencies...
     _filter, _getConverted, _get, _getAndRemove, _insert, _remove, _replace, _sort, 
     // ... end injected dependencies
-    data) {
+    data // the actual array, represented by inherited property this.data
+    ) {
         if (data === void 0) { data = []; }
         var _this = _super.call(this, data) || this;
         _this._filter = _filter;
@@ -65,7 +78,7 @@ var PublicArray = /** @class */ (function (_super) {
         // this.copy  -- returns independent copy of this.
         get: function () {
             // @ts-ignore
-            return di_factory_1.DIFactory.getInstance(PublicArray, [this.get.copy]);
+            return di_factory_1.DIFactory.getInstance(PublicArray, [this.get.copy()]);
         },
         enumerable: true,
         configurable: true

lib/tests.js renamed to dist/tests.d.ts

@@ -1,11 +1,4 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-var index_1 = require("./index");
-var arr = index_1.getPublicArray([1, 2, 3, 4, 5, 6, 7, 8, 9]);
-var otherArr = arr.data;
-otherArr.length = 0;
-console.log(otherArr);
-console.log(arr.data);
+export {};
 /************
  arr.remove.allAfterFirst(6);
  arr.remove.allBeforeFirst(3);

dist/tests.js

@@ -1,11 +1,23 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
 var index_1 = require("./index");
+console.log('hello');
+//let arr = new PublicArrayReplacer([1, 2, 3, 4, 5, 6, 7, 8, 9]);
 var arr = index_1.getPublicArray([1, 2, 3, 4, 5, 6, 7, 8, 9]);
-var otherArr = arr.data;
+console.log(arr.remove.byIndex(0).byIndexes([1, 3, 5]).adjacentAt(1, 2));
+var arrCopy = arr.copy;
+console.log(arrCopy);
+/****************
+
+
+let otherArr = arr.data;
+
 otherArr.length = 0;
+
 console.log(otherArr);
+
 console.log(arr.data);
+ *************/
 /************
  arr.remove.allAfterFirst(6);
  arr.remove.allBeforeFirst(3);

lib/privy/PublicArray.js

@@ -12,7 +12,8 @@ import { PublicArrayFilter } from '@writetome51/public-array-filter';
 
 
 /**************
- This class is called PublicArray because an array is contained inside it, in a public property.
+ This class is called PublicArray because an array is contained inside it,
+ in a public property: 'data'
 
  The main reason you would use this class is if you hate JavaScript's built-in Array
  methods, like .slice(), .splice(), .push(), and .shift().  This class has much clearer
@@ -23,13 +24,25 @@ import { PublicArrayFilter } from '@writetome51/public-array-filter';
  let arr = getPublicArray( [1,2,3,4,5,6] );
  arr.remove.tail(2); // arr.data is now [1,2,3,4]
  if (arr.notEmpty) arr.prepend([10]); // arr.data is now [10,1,2,3,4]
-
- To access the array itself, you access the 'data' property.
  *************/
 
 
 export class PublicArray extends PublicArrayContent {
 
+	/***************
+	 Public Properties:
+
+	 readonly copy: PublicArray; // independent copy of this instance.
+	 readonly filter: PublicArrayFilter;
+	 readonly getConverted: PublicArrayGetterConverter;
+	 readonly get: PublicArrayGetter;
+	 readonly getAndRemove: PublicArrayGetterRemover;
+	 readonly insert: PublicArrayInserter;
+	 readonly remove: PublicArrayRemover;
+	 readonly replace: PublicArrayReplacer;
+	 readonly sort: PublicArraySorter;
+	 ***************/
+
 
 	constructor(
 		// begin injected dependencies...
@@ -43,7 +56,7 @@ export class PublicArray extends PublicArrayContent {
 		private _sort: PublicArraySorter,
 		// ... end injected dependencies
 
-		data = []
+		data = [] // the actual array, represented by inherited property this.data
 	) {
 
 		super(data);
@@ -67,7 +80,7 @@ export class PublicArray extends PublicArrayContent {
 	// this.copy  -- returns independent copy of this.
 	get copy(): PublicArray {
 		// @ts-ignore
-		return DIFactory.getInstance(PublicArray, [this.get.copy]);
+		return DIFactory.getInstance(PublicArray, [this.get.copy()]);
 	}
 
 

lib/privy/PublicArray.ts

@@ -1,7 +1,15 @@
 import { getPublicArray } from './index';
+import { PublicArrayReplacer } from '@writetome51/public-array-replacer';
 
-
+console.log('hello');
+//let arr = new PublicArrayReplacer([1, 2, 3, 4, 5, 6, 7, 8, 9]);
 let arr = getPublicArray([1, 2, 3, 4, 5, 6, 7, 8, 9]);
+console.log(arr.remove.byIndex(0).byIndexes([1,3,5]).adjacentAt(1, 2));
+let arrCopy = arr.copy;
+console.log(arrCopy);
+
+/****************
+
 
 let otherArr = arr.data;
 
@@ -10,6 +18,7 @@ otherArr.length = 0;
 console.log(otherArr);
 
 console.log(arr.data);
+ *************/