rename Lib.isArray -> Lib.isArrayOrTypedArray

... to avoid confusion with Array.isArray and upcoming
    Lib.isTypedArray

Author: etpinard

src/lib/index.js

@@ -22,12 +22,14 @@ lib.nestedProperty = require('./nested_property');
 lib.keyedContainer = require('./keyed_container');
 lib.relativeAttr = require('./relative_attr');
 lib.isPlainObject = require('./is_plain_object');
-lib.isArray = require('./is_array');
 lib.mod = require('./mod');
 lib.toLogRange = require('./to_log_range');
 lib.relinkPrivateKeys = require('./relink_private');
 lib.ensureArray = require('./ensure_array');
 
+var isArrayModule = require('./is_array');
+lib.isArrayOrTypedArray = isArrayModule.isArrayOrTypedArray
+
 var coerceModule = require('./coerce');
 lib.valObjectMeta = coerceModule.valObjectMeta;
 lib.coerce = coerceModule.coerce;

src/lib/is_array.js

@@ -8,15 +8,11 @@
 
 'use strict';
 
-/**
- * Return true for arrays, whether they're untyped or not.
- */
-
 // IE9 fallback
 var ab = (typeof ArrayBuffer === 'undefined' || !ArrayBuffer.isView) ?
     {isView: function() { return false; }} :
     ArrayBuffer;
 
-module.exports = function isArray(a) {
+exports.isArrayOrTypedArray = function(a) {
     return Array.isArray(a) || ab.isView(a);
 };

src/lib/nested_property.js

@@ -10,7 +10,7 @@
 'use strict';
 
 var isNumeric = require('fast-isnumeric');
-var isArray = require('./is_array');
+var isArrayOrTypedArray = require('./is_array').isArrayOrTypedArray;
 var isPlainObject = require('./is_plain_object');
 var containerArrayMatch = require('../plot_api/container_array_match');
 
@@ -96,7 +96,7 @@ function npGet(cont, parts) {
                 }
                 return allSame ? out[0] : out;
             }
-            if(typeof curPart === 'number' && !isArray(curCont)) {
+            if(typeof curPart === 'number' && !isArrayOrTypedArray(curCont)) {
                 return undefined;
             }
             curCont = curCont[curPart];
@@ -144,7 +144,7 @@ function isDeletable(val, propStr) {
     ) {
         return false;
     }
-    if(!isArray(val)) return true;
+    if(!isArrayOrTypedArray(val)) return true;
 
     if(propStr.match(INFO_PATTERNS)) return true;
 
@@ -167,7 +167,7 @@ function npSet(cont, parts, propStr) {
         for(i = 0; i < parts.length - 1; i++) {
             curPart = parts[i];
 
-            if(typeof curPart === 'number' && !isArray(curCont)) {
+            if(typeof curPart === 'number' && !isArrayOrTypedArray(curCont)) {
                 throw 'array index but container is not an array';
             }
 
@@ -211,7 +211,7 @@ function joinPropStr(propStr, newPart) {
 
 // handle special -1 array index
 function setArrayAll(containerArray, innerParts, val, propStr) {
-    var arrayVal = isArray(val),
+    var arrayVal = isArrayOrTypedArray(val),
         allSet = true,
         thisVal = val,
         thisPropStr = propStr.replace('-1', 0),
@@ -261,7 +261,7 @@ function pruneContainers(containerLevels) {
         propPart = containerLevels[i][1];
 
         remainingKeys = false;
-        if(isArray(curCont)) {
+        if(isArrayOrTypedArray(curCont)) {
             for(j = curCont.length - 1; j >= 0; j--) {
                 if(isDeletable(curCont[j], joinPropStr(propPart, j))) {
                     if(remainingKeys) curCont[j] = undefined;
@@ -287,7 +287,7 @@ function pruneContainers(containerLevels) {
 function emptyObj(obj) {
     if(obj === undefined || obj === null) return true;
     if(typeof obj !== 'object') return false; // any plain value
-    if(isArray(obj)) return !obj.length; // []
+    if(isArrayOrTypedArray(obj)) return !obj.length; // []
     return !Object.keys(obj).length; // {}
 }
 

src/lib/relink_private.js

@@ -9,7 +9,7 @@
 
 'use strict';
 
-var isArray = require('./is_array');
+var isArrayOrTypedArray = require('./is_array').isArrayOrTypedArray;
 var isPlainObject = require('./is_plain_object');
 
 /**
@@ -35,7 +35,7 @@ module.exports = function relinkPrivateKeys(toContainer, fromContainer) {
 
             toContainer[k] = fromVal;
         }
-        else if(isArray(fromVal) && isArray(toVal) && isPlainObject(fromVal[0])) {
+        else if(isArrayOrTypedArray(fromVal) && isArrayOrTypedArray(toVal) && isPlainObject(fromVal[0])) {
 
             // filter out data_array items that can contain user objects
             // most of the time the toVal === fromVal check will catch these early

src/plots/array_container_defaults.js

@@ -10,7 +10,6 @@
 
 var Lib = require('../lib');
 
-
 /** Convenience wrapper for making array container logic DRY and consistent
  *
  * @param {object} parentObjIn
@@ -46,7 +45,7 @@ module.exports = function handleArrayContainerDefaults(parentObjIn, parentObjOut
 
     var previousContOut = parentObjOut[name];
 
-    var contIn = Lib.isArray(parentObjIn[name]) ? parentObjIn[name] : [],
+    var contIn = Lib.isArrayOrTypedArray(parentObjIn[name]) ? parentObjIn[name] : [],
         contOut = parentObjOut[name] = [],
         i;
 
@@ -70,7 +69,7 @@ module.exports = function handleArrayContainerDefaults(parentObjIn, parentObjOut
 
     // in case this array gets its defaults rebuilt independent of the whole layout,
     // relink the private keys just for this array.
-    if(Lib.isArray(previousContOut)) {
+    if(Lib.isArrayOrTypedArray(previousContOut)) {
         var len = Math.min(previousContOut.length, contOut.length);
         for(i = 0; i < len; i++) {
             Lib.relinkPrivateKeys(contOut[i], previousContOut[i]);

src/traces/carpet/cheater_basis.js

@@ -8,7 +8,7 @@
 
 'use strict';
 
-var isArray = require('../../lib').isArray;
+var isArrayOrTypedArray = require('../../lib').isArrayOrTypedArray;
 
 /*
  * Construct a 2D array of cheater values given a, b, and a slope.
@@ -18,10 +18,10 @@ module.exports = function(a, b, cheaterslope) {
     var i, j, ascal, bscal, aval, bval;
     var data = [];
 
-    var na = isArray(a) ? a.length : a;
-    var nb = isArray(b) ? b.length : b;
-    var adata = isArray(a) ? a : null;
-    var bdata = isArray(b) ? b : null;
+    var na = isArrayOrTypedArray(a) ? a.length : a;
+    var nb = isArrayOrTypedArray(b) ? b.length : b;
+    var adata = isArrayOrTypedArray(a) ? a : null;
+    var bdata = isArrayOrTypedArray(b) ? b : null;
 
     // If we're using data, scale it so that for data that's just barely
     // not evenly spaced, the switch to value-based indexing is continuous.

src/traces/parcoords/calc.js

@@ -14,7 +14,7 @@ var Lib = require('../../lib');
 var wrap = require('../../lib/gup').wrap;
 
 module.exports = function calc(gd, trace) {
-    var cs = !!trace.line.colorscale && Lib.isArray(trace.line.color);
+    var cs = !!trace.line.colorscale && Lib.isArrayOrTypedArray(trace.line.color);
     var color = cs ? trace.line.color : Array.apply(0, Array(trace.dimensions.reduce(function(p, n) {return Math.max(p, n.values.length);}, 0))).map(function() {return 0.5;});
     var cscale = cs ? trace.line.colorscale : [[0, trace.line.color], [1, trace.line.color]];
 

src/traces/parcoords/defaults.js

@@ -18,7 +18,7 @@ function handleLineDefaults(traceIn, traceOut, defaultColor, layout, coerce) {
 
     coerce('line.color', defaultColor);
 
-    if(hasColorscale(traceIn, 'line') && Lib.isArray(traceIn.line.color)) {
+    if(hasColorscale(traceIn, 'line') && Lib.isArrayOrTypedArray(traceIn.line.color)) {
         coerce('line.colorscale');
         colorscaleDefaults(traceIn, traceOut, layout, coerce, {prefix: 'line.', cLetter: 'c'});
     }

src/traces/sankey/render.js

@@ -87,15 +87,15 @@ function sankeyModel(layout, d, i) {
         return {
             pointNumber: i,
             label: l,
-            color: Lib.isArray(nodeSpec.color) ? nodeSpec.color[i] : nodeSpec.color
+            color: Lib.isArrayOrTypedArray(nodeSpec.color) ? nodeSpec.color[i] : nodeSpec.color
         };
     });
 
     var links = linkSpec.value.map(function(d, i) {
         return {
             pointNumber: i,
             label: linkSpec.label[i],
-            color: Lib.isArray(linkSpec.color) ? linkSpec.color[i] : linkSpec.color,
+            color: Lib.isArrayOrTypedArray(linkSpec.color) ? linkSpec.color[i] : linkSpec.color,
             source: linkSpec.source[i],
             target: linkSpec.target[i],
             value: d

test/jasmine/tests/is_array_test.js

@@ -1,10 +1,6 @@
 var Lib = require('@src/lib');
 
-describe('isArray', function() {
-    'use strict';
-
-    var isArray = Lib.isArray;
-
+describe('isArrayOrTypedArray', function() {
     function A() {}
 
     var shouldPass = [
@@ -35,13 +31,13 @@ describe('isArray', function() {
 
     shouldPass.forEach(function(obj) {
         it('treats ' + JSON.stringify(obj) + ' as an array', function() {
-            expect(isArray(obj)).toBe(true);
+            expect(Lib.isArrayOrTypedArray(obj)).toBe(true);
         });
     });
 
     shouldFail.forEach(function(obj) {
         it('treats ' + JSON.stringify(obj !== window ? obj : 'window') + ' as NOT an array', function() {
-            expect(isArray(obj)).toBe(false);
+            expect(Lib.isArrayOrTypedArray(obj)).toBe(false);
         });
     });
 });