jupyter-ijavascript-utils 1.60.0 → 1.61.1

package/Dockerfile

@@ -1,3 +1,3 @@
 # syntax=docker/dockerfile:1
 
-FROM darkbluestudios/jupyter-ijavascript-utils:binder_1.60.0
+FROM darkbluestudios/jupyter-ijavascript-utils:binder_1.61.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "jupyter-ijavascript-utils",
-  "version": "1.60.0",
+  "version": "1.61.1",
   "description": "Utilities for working with iJavaScript - a Jupyter Kernel",
   "homepage": "https://jupyter-ijavascript-utils.onrender.com/",
   "license": "MIT",

package/src/TableGenerator.js

@@ -1751,7 +1751,7 @@ class TableGenerator {
     const prepResults = this.prepare();
     const results = {};
     const createFrameList = () => new Array(prepResults.data.length).fill(undefined);
-    prepResults.headers.forEach((header) => ObjectUtils.assign(results, header, createFrameList()));
+    prepResults.headers.forEach((header) => ObjectUtils.assignIP(results, header, createFrameList()));
 
     prepResults.data.forEach((row, rowIndex) => {
       row.forEach((value, valIndex) => {

package/src/aggregate.js

@@ -549,7 +549,7 @@ module.exports.first = function first(collection, accessor) {
  * @param {Array} collection -
  * @returns {Number}
  * @example
- * utils.aggregate.count([0.87, 2.68, 5.31, 3.94, 4.13, 3.58, 3.62, 2.56]);
+ * utils.aggregate.length([0.87, 2.68, 5.31, 3.94, 4.13, 3.58, 3.62, 2.56]);
  * // 8
  */
 module.exports.length = function length(collection) {
@@ -684,7 +684,7 @@ module.exports.countMap = function countMap(collection, accessor, uniquifierFn)
  *   { station: 'A', timestamp: new Date(2022, 0, 2, 9, 30) },
  *   { station: 'B', timestamp: new Date(2022, 0, 2, 10, 0) },
  *   { station: 'A', timestamp: new Date(2022, 0, 3, 10, 0) },
- *   { station: 'B', timestamp: new Date(2022, 0, 3, 10, 0 }
+ *   { station: 'B', timestamp: new Date(2022, 0, 3, 10, 0) }
  * ]
  * utils.aggregate.count(series, 'timestamp', (d) => d.toISOString().slice(0, 10))
  * // { '2022-01-01': 3, '2022-01-02': 2, '2022-01-03': 2 }
@@ -744,7 +744,7 @@ module.exports.duplicates = function duplicates(collection, accessor, uniquifier
  * const superSet = new Set(['a', 'b', 'c']);
  * const data = [{ val: 'a' }, { val: 'b' }, { val: 'c' }, { val: 'd' }];
  * 
- * aggregate.notIn(data, 'val', superSet);
+ * utils.aggregate.notIn(data, 'val', superSet);
  * // Set('d')
  */
 module.exports.notIn = function notIn(collection, accessor, targetIterator) {
@@ -768,13 +768,13 @@ module.exports.notIn = function notIn(collection, accessor, targetIterator) {
  * @returns {Boolean} - whether the values in the array are truly unique
  * @example
  * let data = [{ val: 1 }, { val: 2 }, { val: 3 }, { val: 1 }];
- * aggregate.isUnique(data, 'val'); // false
+ * utils.aggregate.isUnique(data, 'val'); // false
  * 
  * let data = [{ val: 1 }, { val: 2 }, { val: 3 }];
- * aggregate.isUnique(data, 'val'); // true
+ * utils.aggregate.isUnique(data, 'val'); // true
  * 
  * data = ['a', 'b', 'c', 'd'];
- * aggregate.isUnique(data); // true
+ * utils.aggregate.isUnique(data); // true
  */
 module.exports.isUnique = function isUnique(collection, accessor) {
   const cleanedFunc = ObjectUtils.evaluateFunctionOrProperty(accessor);
@@ -981,7 +981,7 @@ module.exports.percentile_99 = function percentile(collection, accessor) {
  * // 0.87, 2.56, 2.68, 3.58, 3.62
  * 
  * //-- you can also combine values to make the values clearer, by passing a function
- * const monthPrecip = function (record) => `${record.month} (${record.precip})`;
+ * const monthPrecip = (record) => `${record.month} (${record.precip})`;
  * utils.aggregate.topValues(collection, 3, monthPrecip, '-precip');
  * // '2021-Oct (5.31)', '2021-Dec (4.13)', '2022-Mar (3.98)'
  * ```
@@ -998,7 +998,7 @@ module.exports.percentile_99 = function percentile(collection, accessor) {
  * 
  * //-- bottom 5 values
  * utils.aggregate.topValues(collection, 5, null, '');
- * // 
+ * // [0.87, 2.56, 2.68, 3.58, 3.62]
  * ```
  * 
  * @param {Array} collection - Collection of values we want to get the top values from

package/src/array.js

@@ -63,18 +63,16 @@ const ArrayUtils = module.exports;
  * @type {Function}
  * @example
  * 
- * [3,5,1,2,4].sort(utils.sort.SIMPLE_ASCENDING))
- * //
- * [1,2,3,4,5]
+ * [3,5,1,2,4].sort(utils.array.SIMPLE_ASCENDING)
+ * // [1,2,3,4,5]
  */
 module.exports.SORT_ASCENDING = (a, b) => a === b ? 0 : a > b ? 1 : -1;
 
 /**
  * Simple descending sort function
  * @example
- * [3,5,1,2,4].sort(utils.sort.SIMPLE_ASCENDING))
- * //
- * [5,4,3,2,1]
+ * [3,5,1,2,4].sort(utils.array.SORT_DESCENDING)
+ * // [5,4,3,2,1]
  * @type {Function}
  */
 module.exports.SORT_DESCENDING = (a, b) => a === b ? 0 : a > b ? -1 : 1;
@@ -83,16 +81,17 @@ module.exports.SORT_DESCENDING = (a, b) => a === b ? 0 : a > b ? -1 : 1;
  * Creates a sort function based on fields of an object.
  * 
  * ```
- * sampleData = [{score: 200, name: 'jane'}, {score: 200, name: 'john'}]
+ * [{score: 200, name: 'jane'}, {score: 300, name: 'john'}, {score: 300, name: 'jonny'}];
  * // sort by score descending, and then by name ascending
- * sampleData.sort(utils.array.createSort('-score','name'))
+ * sampleData.sort(utils.array.createSort('-score','name'));
+ * // [{ score: 300, name: 'john' }, { score: 300, name: 'jonny' },{ score: 200, name: 'jane' }]
  * ```
  * 
  * @example
  * 
  * sampleData = [{i:4}, {v:2}, {v:1}, {v:3}];
  * sortedData = sampleData.sort(
- *    utils.createSort('-v')
+ *    utils.array.createSort('-v')
  * );
  * // [{v:4}, {v:3}, {v:2}, {v:1}]
  * 
@@ -427,16 +426,16 @@ module.exports.applyArrayValue = function applyArrayValue(collection, path, valu
  * cities = utils.object.extractObjectProperty('city');
  * // ['Seattle', 'New York', 'Chicago'];
  * 
- * //-- async process to geocode
- * geocodedCities = geocodeCity(cities);
- * // [{ city: 'Seattle', state: 'WA', country: 'USA' },
- * // { city: 'New York', state: 'NY', country: 'USA' },
- * // { city: 'Chicago', state: 'IL', country: 'USA' }]
+ * //-- get a separate dataset that needs to be joined, like geocodeCity(cities);
+ * geocodedCities = [{ city: 'Seattle', state: 'WA', country: 'USA' },
+ *   { city: 'New York', state: 'NY', country: 'USA' },
+ *   { city: 'Chicago', state: 'IL', country: 'USA' }];
  * 
- * utils.applyArrayValues(weather, 'geo', geocodedCities);
+ * utils.array.applyArrayValues(weather, 'geo', geocodedCities);
  * // [{ id: 1, city: 'Seattle',  month: 'Aug', precip: 0.87, geo: { city: 'Seattle', state: 'WA', country: 'USA' } },
  * //  { id: 3, city: 'New York', month: 'Apr', precip: 3.94, geo: { city: 'New York', state: 'NY', country: 'USA' } },
  * //  { id: 6, city: 'Chicago',  month: 'Apr', precip: 3.62, geo: { city: 'Chicago', state: 'IL', country: 'USA' } }];
+ * ```
  * 
  * Note that traditional [Array.map](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/map)
  * works best for if you are working with objects completely in memory.
@@ -505,14 +504,14 @@ module.exports.size = function size(length, defaultValue) {
  * 
  * utils.array.arange(10, 1)
  *  .map((val) => `item ${val}`);
- * //
- * [
- *   'item 1', 'item 2',
- *   'item 3', 'item 4',
- *   'item 5', 'item 6',
- *   'item 7', 'item 8',
- *   'item 9', 'item 10'
- * ]
+ * 
+ * // [
+ * //   'item 1', 'item 2',
+ * //   'item 3', 'item 4',
+ * //   'item 5', 'item 6',
+ * //   'item 7', 'item 8',
+ * //   'item 9', 'item 10'
+ * // ]
  * @param {Number} length - the number of items toreturn
  * @param {Number} [start=0] - the starting number
  * @param {Number} [step=1] - the number to increment for each step
@@ -573,13 +572,13 @@ module.exports.arrayLength2d = function arrayLength2d(targetArray) {
  * @example
  * 
  * baseArray = [ 0, 1, 2, 3, 4 ];
- * utils.array.transpose(utils.array.arrange(5))
- * //
- * [ [ 0 ],
- *   [ 1 ],
- *   [ 2 ],
- *   [ 3 ],
- *   [ 4 ] ]
+ * utils.array.transpose(utils.array.arrange(5));
+ * 
+ * // [ [ 0 ],
+ * //   [ 1 ],
+ * //   [ 2 ],
+ * //   [ 3 ],
+ * //   [ 4 ] ]
  */
 module.exports.transpose = function transpose(matrix) {
   //-- fast fail
@@ -618,22 +617,22 @@ module.exports.transpose = function transpose(matrix) {
  * @example
  * 
  * baseArray = utils.array.arrange(12);
- * [
- *    0,  1, 2, 3, 4, 5,  6, 7, 8, 9, 10, 11
- * ]
+ * // [
+ * //    0,  1, 2, 3, 4, 5,  6, 7, 8, 9, 10, 11
+ * // ]
  * 
  * //-- reshape the 1d array based on 3 columns
  * newArray = utils.array.reshape(baseArray, 3)
- * [ [ 0, 1, 2 ],
- *   [ 3, 4, 5 ],
- *   [ 6, 7, 8 ],
- *   [ 9, 10, 11 ] ];
+ * // [ [ 0, 1, 2 ],
+ * //   [ 3, 4, 5 ],
+ * //   [ 6, 7, 8 ],
+ * //   [ 9, 10, 11 ] ];
  * 
  * //-- now reshape the 4x3 array to 3x4
  * utils.array.reshape(newArray, 4);
- * [ [ 0, 1, 2, 3 ],
- *   [ 4, 5, 6, 7 ],
- *   [ 8, 9, 10, 11 ] ]
+ * // [ [ 0, 1, 2, 3 ],
+ * //   [ 4, 5, 6, 7 ],
+ * //   [ 8, 9, 10, 11 ] ]
  */
 module.exports.reshape = function reshape(sourceArray, numColumns) {
   const results = [];
@@ -710,7 +709,7 @@ module.exports.clone = function clone(target) {
  * //   [ 3, 0 ], [ 3, 1 ], [ 3, 2 ], [ 3, 3 ]
  * // ]
  * 
- * myList.forEach((value, index) => {
+ * gridPositions.forEach((value, index) => {
  *   const [x, y] = gridPositions[index];
  *   console.log(`placing ${value} in row:${x}, column:${y}`);
  * });
@@ -779,41 +778,41 @@ module.exports.arangeMulti = module.exports.arrangeMulti;
  * isHeader1('This describes section A'); // false
  * 
  * indexedData = utils.array.indexify(data, isHeader1);
- * [
- *   { entry: 'Heading', section: [ 0 ], subIndex: 1 },
- *   { entry: '# Overview', section: [ 1 ], subIndex: 0 },
- *   {
- *     entry: 'This entire list is a hierarchy of data.',
- *     section: [ 1 ],
- *     subIndex: 1
- *   },
- *   { entry: '# Section A', section: [ 2 ], subIndex: 0 },
- *   { entry: 'This describes section A', section: [ 2 ], subIndex: 1 },
- *   { entry: '## SubSection 1', section: [ 2 ], subIndex: 2 },
- *   {
- *     entry: 'With a subsection belonging to Section A',
- *     section: [ 2 ],
- *     subIndex: 3
- *   },
- *   { entry: '## SubSection 2', section: [ 2 ], subIndex: 4 },
- *   {
- *     entry: 'And another subsection sibling to SubSection 1, but also under Section A.',
- *     section: [ 2 ],
- *     subIndex: 5
- *   },
- *   { entry: '# Section B', section: [ 3 ], subIndex: 0 },
- *   {
- *     entry: 'With an entirely unrelated section B, that is sibling to Section A',
- *     section: [ 3 ],
- *     subIndex: 1
- *   },
- *   { entry: '## SubSection 1', section: [ 3 ], subIndex: 2 },
- *   {
- *     entry: 'And another subsection 1, but this time related to Section B.',
- *     section: [ 3 ],
- *     subIndex: 3
- *   }
- * ];
+ * // [
+ * //   { entry: 'Heading', section: [ 0 ], subIndex: 1 },
+ * //   { entry: '# Overview', section: [ 1 ], subIndex: 0 },
+ * //   {
+ * //     entry: 'This entire list is a hierarchy of data.',
+ * //     section: [ 1 ],
+ * //     subIndex: 1
+ * //   },
+ * //   { entry: '# Section A', section: [ 2 ], subIndex: 0 },
+ * //   { entry: 'This describes section A', section: [ 2 ], subIndex: 1 },
+ * //   { entry: '## SubSection 1', section: [ 2 ], subIndex: 2 },
+ * //   {
+ * //     entry: 'With a subsection belonging to Section A',
+ * //     section: [ 2 ],
+ * //     subIndex: 3
+ * //   },
+ * //   { entry: '## SubSection 2', section: [ 2 ], subIndex: 4 },
+ * //   {
+ * //     entry: 'And another subsection sibling to SubSection 1, but also under Section A.',
+ * //     section: [ 2 ],
+ * //     subIndex: 5
+ * //   },
+ * //   { entry: '# Section B', section: [ 3 ], subIndex: 0 },
+ * //   {
+ * //     entry: 'With an entirely unrelated section B, that is sibling to Section A',
+ * //     section: [ 3 ],
+ * //     subIndex: 1
+ * //   },
+ * //   { entry: '## SubSection 1', section: [ 3 ], subIndex: 2 },
+ * //   {
+ * //     entry: 'And another subsection 1, but this time related to Section B.',
+ * //     section: [ 3 ],
+ * //     subIndex: 3
+ * //   }
+ * // ];
  * ```
  * 
  * Note that this only indexes elements by the first header.
@@ -924,8 +923,8 @@ module.exports.indexify = function indexify(source, ...sectionIndicatorFunctions
  * For example, say you got a string formatted like this:
  * 
  * ```
- * hardSpacedString = `
- * id first_name last_name  city        email                        gender ip_address      airport_code car_model_year
+ * hardSpacedString = '' +
+ * `id first_name last_name  city        email                        gender ip_address      airport_code car_model_year
  * -- ---------- ---------- ----------- ---------------------------- ------ --------------- ------------ --------------
  * 1  Thekla     Brokenshaw Chicago     tbrokenshaw0@kickstarter.com Female 81.118.170.238  CXI          2003          
  * 2  Lexi       Dugall     New York    ldugall1@fc2.com             Female 255.140.25.31   LBH          2005          
@@ -976,8 +975,8 @@ module.exports.multiLineSubstr = function multiLineSubstr(target, start, length)
  * For example, say you got a string formatted like this:
  * 
  * ```
- * hardSpacedString = `
- * id first_name last_name  city        email                        gender ip_address      airport_code car_model_year
+ * hardSpacedString = '' +
+ * `id first_name last_name  city        email                        gender ip_address      airport_code car_model_year
  * -- ---------- ---------- ----------- ---------------------------- ------ --------------- ------------ --------------
  * 1  Thekla     Brokenshaw Chicago     tbrokenshaw0@kickstarter.com Female 81.118.170.238  CXI          2003          
  * 2  Lexi       Dugall     New York    ldugall1@fc2.com             Female 255.140.25.31   LBH          2005          
@@ -1029,8 +1028,8 @@ module.exports.multiLineSubstring = function multiLineSubstring(target, startPos
  * For example:
  * 
  * ```
- * hardSpacedString = `
- * id first_name last_name  city        email                        gender ip_address      airport_code car_model_year
+ * hardSpacedString = '' +
+ * `id first_name last_name  city        email                        gender ip_address      airport_code car_model_year
  * -- ---------- ---------- ----------- ---------------------------- ------ --------------- ------------ --------------
  * 1  Thekla     Brokenshaw Chicago     tbrokenshaw0@kickstarter.com Female 81.118.170.238  CXI          2003          
  * 2  Lexi       Dugall     New York    ldugall1@fc2.com             Female 255.140.25.31   LBH          2005          
@@ -1072,7 +1071,7 @@ module.exports.multiLineSubstring = function multiLineSubstring(target, startPos
  * cityStartingCharacter = substrPairs[3][0]; // 25
  * cityColumnLength = substrPairs[3][1]; // 12
  * 
- * cityData = ArrayUtils.multiLineSubstr(hardSpacedString, cityStartingCharacter, cityColumnLength);
+ * cityData = utils.array.multiLineSubstr(hardSpacedString, cityStartingCharacter, cityColumnLength);
  * // ['city        ', '----------- ', 'Chicago     ', 'New York    ', 'London      ', 'Lainqu      ', 'Los Angeles ']
  * ```
  * 
@@ -1080,18 +1079,18 @@ module.exports.multiLineSubstring = function multiLineSubstring(target, startPos
  * 
  * ```
  * results = substrPairs.map(
- *  ([startingPos, length]) => ArrayUtils.multiLineSubstr(hardSpacedString, startingPos, length)
+ *  ([startingPos, length]) => utils.array.multiLineSubstr(hardSpacedString, startingPos, length)
  * );
  * 
- * [['id ', '-- ', '1  ', '2  ', '3  ', '4  ', '5  '],
- * ['first_name ', '---------- ', 'Thekla     ', 'Lexi       ', 'Shawna     ', 'Gin...', ...],
- * ['last_name  ', '---------- ', 'Brokenshaw ', 'Dugall     ', 'Burghill   ', 'Twe...', ...],
- * ['city        ', '----------- ', 'Chicago     ', 'New York    ', 'London      ', ...],
- * ['email                        ', '---------------------------- ', 'tbrokenshaw0...', ...],
- * ['gender ', '------ ', 'Female ', 'Female ', 'Female ', 'Female ', 'Female '],
- * ['ip_address      ', '--------------- ', '81.118.170.238  ', '255.140.25.31   ', ...],
- * ['airport_code ', '------------ ', 'CXI          ', 'LBH          ', 'GBA       ...', ...],
- * ['car_model_year', '--------------', '2003          ', '2005          ', '2004  ...', ...]]
+ * // [['id ', '-- ', '1  ', '2  ', '3  ', '4  ', '5  '],
+ * // ['first_name ', '---------- ', 'Thekla     ', 'Lexi       ', 'Shawna     ', 'Gin...', ...],
+ * // ['last_name  ', '---------- ', 'Brokenshaw ', 'Dugall     ', 'Burghill   ', 'Twe...', ...],
+ * // ['city        ', '----------- ', 'Chicago     ', 'New York    ', 'London      ', ...],
+ * // ['email                        ', '---------------------------- ', 'tbrokenshaw0...', ...],
+ * // ['gender ', '------ ', 'Female ', 'Female ', 'Female ', 'Female ', 'Female '],
+ * // ['ip_address      ', '--------------- ', '81.118.170.238  ', '255.140.25.31   ', ...],
+ * // ['airport_code ', '------------ ', 'CXI          ', 'LBH          ', 'GBA       ...', ...],
+ * // ['car_model_year', '--------------', '2003          ', '2005          ', '2004  ...', ...]]
  * ```
  * 
  * We can then transpose the array to give us the format we might expect (non DataFrame centric)
@@ -1154,17 +1153,17 @@ module.exports.multiStepReduce = function multiStepReduce(list, fn, initialValue
  * // [ 3, 11, 11, 12, 29, 7, 16, 13, 15 ];
  * 
  * 
- * results = utils.array.extractFromHardSpacedTable(str, columnWidths);
+ * results = utils.array.extractFromHardSpacedTable(hardSpacedString, columnWidths);
  * 
- * [['id ', '-- ', '1  ', '2  ', '3  ', '4  ', '5  '],
- * ['first_name ', '---------- ', 'Thekla     ', 'Lexi       ', 'Shawna     ', 'Gin...', ...],
- * ['last_name  ', '---------- ', 'Brokenshaw ', 'Dugall     ', 'Burghill   ', 'Twe...', ...],
- * ['city        ', '----------- ', 'Chicago     ', 'New York    ', 'London      ', ...],
- * ['email                        ', '---------------------------- ', 'tbrokenshaw0...', ...],
- * ['gender ', '------ ', 'Female ', 'Female ', 'Female ', 'Female ', 'Female '],
- * ['ip_address      ', '--------------- ', '81.118.170.238  ', '255.140.25.31   ', ...],
- * ['airport_code ', '------------ ', 'CXI          ', 'LBH          ', 'GBA       ...', ...],
- * ['car_model_year', '--------------', '2003          ', '2005          ', '2004  ...', ...]]
+ * // [['id ', '-- ', '1  ', '2  ', '3  ', '4  ', '5  '],
+ * // ['first_name ', '---------- ', 'Thekla     ', 'Lexi       ', 'Shawna     ', 'Gin...', ...],
+ * // ['last_name  ', '---------- ', 'Brokenshaw ', 'Dugall     ', 'Burghill   ', 'Twe...', ...],
+ * // ['city        ', '----------- ', 'Chicago     ', 'New York    ', 'London      ', ...],
+ * // ['email                        ', '---------------------------- ', 'tbrokenshaw0...', ...],
+ * // ['gender ', '------ ', 'Female ', 'Female ', 'Female ', 'Female ', 'Female '],
+ * // ['ip_address      ', '--------------- ', '81.118.170.238  ', '255.140.25.31   ', ...],
+ * // ['airport_code ', '------------ ', 'CXI          ', 'LBH          ', 'GBA       ...', ...],
+ * // ['car_model_year', '--------------', '2003          ', '2005          ', '2004  ...', ...]]
  * ```
  * 
  * We can then transpose the array to give us the format we might expect (non DataFrame centric)
@@ -1458,9 +1457,11 @@ module.exports.asyncWaitAndChain = (seconds, fn, rows) => {
  * ```
  * categoryValues = ['rock', 'paper', 'scissors'];
  * 
+ * //-- resizes an array to be shorter - truncating
  * utils.array.resize(categoryValues, 2); // ['rock', 'paper']
- * utils.array.resize(categoryValues, 7); // ['rock', 'paper', 'scissors',
- * undefined, undefined, undefined, undefined];
+ * 
+ * //-- resizes an array to be longer - filling with undefined
+ * utils.array.resize(categoryValues, 7); // ['rock', 'paper', 'scissors', undefined, undefined, undefined, undefined];
  * ```
  * 
  * @param {Array} sourceList - array of values

package/src/chain.js

@@ -87,7 +87,9 @@
  * ```
  * results = [{ userId: 'abc123' }, { userId: 'xyz987' }];
  * 
- * activeUsers = chain(results)
+ * // joining to existing collection of users
+ * 
+ * activeUsers = utils.chain(results)
  *  .chainMap((record) => users.get(record.userId))
  *  .chainForEach(record => record.status =  'active')
  *  .chain(records => d3.csv.format(records))
@@ -104,7 +106,7 @@
  *  + 'and%20I%20quote%20the%20fights%0AHistorical%0AFrom%20Marath'
  *  + 'on%20to%20Waterloo%2C%20in%20order%20categorical';
  * 
- * chain(badStr)
+ * utils.chain(badStr)
  *     .chain(decodeURIComponent)
  *     .chain(v => v.split('\n'))
  *     // .debug()                  // check the values along the way
@@ -190,7 +192,7 @@ class ChainContainer {
    * value = 2;
    * plus2 = (value) => value + 2;
    * 
-   * chain(value)
+   * utils.chain(value)
    *  .chain(plus2) // 2 + 2
    *  .chain(plus2) // 4 + 2
    *  .debug()
@@ -210,7 +212,7 @@ class ChainContainer {
    *  + 'and%20I%20quote%20the%20fights%0AHistorical%0AFrom%20Marath'
    *  + 'on%20to%20Waterloo%2C%20in%20order%20categorical';
    * 
-   * chain(badStr)
+   * utils.chain(badStr)
    *     .chain(decodeURIComponent)
    *     .chain(v => v.split('\n'))
    *     // .debug()                  // check the values along the way
@@ -338,7 +340,7 @@ class ChainContainer {
    * filterOdd(2); // [2]
    * filterOdd(1); // []
    * 
-   * chain([1, 2, 3, 4, 5])
+   * utils.chain([1, 2, 3, 4, 5])
    *  .chainFlatMap(filterOdd)
    *  .close();
    * 
@@ -359,7 +361,7 @@ class ChainContainer {
    * Assuming that value is an array, this maps fn to filter the results in the array.
    * 
    * ```
-   * chain([1,2,3,4])
+   * utils.chain([1,2,3,4])
    *    .chainFilter((value) => value < 3)
    *    .close();
    * // [1, 2]
@@ -412,7 +414,7 @@ class ChainContainer {
    * value = 2;
    * plus2 = (value) => value + 2;
    * 
-   * chain(value)
+   * utils.chain(value)
    *  .chain(plus2) // 2 + 2
    *  .chain(plus2) // 4 + 2
    *  .debug()
@@ -443,7 +445,7 @@ class ChainContainer {
    * ```
    * results = [{ userId: 'abc123' }, { userId: 'xyz987' }];
    * 
-   * activeUsers = chain(results)
+   * activeUsers = utils.chain(results)
    *  .chainMap((record) => users.get(record.userId))
    *  .chainForEach(record => record.status =  'active')
    *  .chain(records => d3.csv.format(records))
@@ -472,7 +474,7 @@ class ChainContainer {
    *   throw Error('Custom Error');
    * };
    * 
-   * chain(2)
+   * utils.chain(2)
    *   .errorHandler(flipSwitch)
    *   .chain((value) => value + 2)
    *   .chain(throwError);
@@ -642,7 +644,7 @@ class ChainContainer {
  * Very helpful for taking values and then progressively working on them,
  * instead of continually wrapping deeper in method calls.
  * 
- * Calling `chain(3)` - gives an object you can then chain calls against:
+ * Calling `utils.chain(3)` - gives an object you can then chain calls against:
  * 
  * * {@link ChainContainer#close|.close()} - gets the value of the current chain
  * * {@link ChainContainer#chain|.chain(function)} - where it is passed the value, and returns a new Chain with that value.
@@ -720,7 +722,7 @@ class ChainContainer {
  * ```
  * results = [{ userId: 'abc123' }, { userId: 'xyz987' }];
  * 
- * activeUsers = chain(results)
+ * activeUsers = utils.chain(results)
  *  .chainMap((record) => users.get(record.userId))
  *  .chainForEach(record => record.status =  'active')
  *  .chain(records => d3.csv.format(records))
@@ -737,7 +739,7 @@ class ChainContainer {
  *  + 'and%20I%20quote%20the%20fights%0AHistorical%0AFrom%20Marath'
  *  + 'on%20to%20Waterloo%2C%20in%20order%20categorical';
  * 
- * chain(badStr)
+ * utils.chain(badStr)
  *     .chain(decodeURIComponent)
  *     .chain(v => v.split('\n'))
  *     // .debug()                  // check the values along the way