@util.js/arrays 0.41.6 → 0.41.8

package/dist/Arrays.js

@@ -0,0 +1,117 @@
+"use strict";
+
+/**
+ * JavaScript utility methods for [arrays]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array}
+ * @public
+ * @class
+ */
+var _interopRequireDefault = require("@babel/runtime-corejs3/helpers/interopRequireDefault");
+var _from = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/array/from"));
+var _isArray = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/array/is-array"));
+var _of = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/array/of"));
+var _sort = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/sort"));
+var _slice = _interopRequireDefault(require("@babel/runtime-corejs3/core-js-stable/instance/slice"));
+var _classCallCheck2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/classCallCheck"));
+var _createClass2 = _interopRequireDefault(require("@babel/runtime-corejs3/helpers/createClass"));
+var Arrays = /*#__PURE__*/function () {
+  function Arrays() {
+    (0, _classCallCheck2["default"])(this, Arrays);
+  }
+  return (0, _createClass2["default"])(Arrays, [{
+    key: "from",
+    value:
+    /**
+     * Creates a new, shallow-copied Array instance from an array-like or iterable object.
+     *
+     * See MDN's documentation about [from]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from}.
+     *
+     * @param arrayLike An array-like or iterable object to convert to an array
+     * @param {Function} [mapFn] Map function to call on every element of the array
+     * @param {Object} [thisArg] Value to use as this when executing mapFn
+     * @return {Array} A new Array instance
+     * @public
+     * @instance
+     * @function
+     */
+    function from() {
+      return _from["default"].apply(Array, arguments);
+    }
+
+    /**
+     * Determines whether the passed value is an Array.
+     *
+     * See MDN's documentation about [isArray]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray}.
+     *
+     * @param {*} obj The object to be checked
+     * @return {boolean} true if the object is an Array or false otherwise
+     * @public
+     * @instance
+     * @function
+     */
+  }, {
+    key: "isArray",
+    value: function isArray() {
+      return _isArray["default"].apply(Array, arguments);
+    }
+
+    /**
+     * Creates a new Array instance with a variable number of arguments, regardless of number or type of the arguments
+     *
+     * See MDN's documentation about [of]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/of}.
+     *
+     * @param {...*} elementN Elements of which to create the array
+     * @return {Array} A new Array instance
+     * @public
+     * @instance
+     * @function
+     */
+  }, {
+    key: "of",
+    value: function of() {
+      return _of["default"].apply(Array, arguments);
+    }
+
+    /**
+     * Shuffles the elements of the specified array.
+     *
+     * See [knuth-shuffle]{@link https://www.npmjs.com/package/knuth-shuffle}.
+     *
+     * @param {Array} array The array to shuffle
+     * @return {Array} A new Array instance with shuffled elements
+     * @public
+     * @instance
+     * @function
+     */
+  }, {
+    key: "shuffle",
+    value: function shuffle(array) {
+      return knuthshuffle().knuthShuffle(this.from(array));
+    }
+
+    /**
+     * Sorts the elements of an array and returns a **new array** with the sorted elements. The default sort order is ascending, built upon converting the elements into strings, then comparing their sequences of UTF-16 code units values.
+     *
+     * See MDN's documentation about [sort]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort}.
+     *
+     * @param {Array} array The array to sort
+     * @return {Array} A new Array instance with sorted elements
+     * @public
+     * @instance
+     * @function
+     */
+  }, {
+    key: "sort",
+    value: function sort(array, compareFunction) {
+      var _context;
+      // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort
+      // https://stackoverflow.com/questions/9592740/how-can-you-sort-an-array-without-mutating-the-original-array
+      // https://stackoverflow.com/a/9592755
+      return (0, _sort["default"])(_context = (0, _slice["default"])(Array.prototype).call(array)).call(_context, compareFunction);
+    }
+  }]);
+}();
+module.exports = Arrays;
+var dependencies = {};
+function knuthshuffle() {
+  return dependencies["knuth-shuffle"] || (dependencies["knuth-shuffle"] = require("knuth-shuffle"));
+}

package/package.json

@@ -9,6 +9,10 @@
     "work in https://npm.runkit.com."
   ],
   "description": "JavaScript utility methods for arrays",
+  "files": [
+    "dist",
+    "index.js"
+  ],
   "keywords": [
     "array",
     "arrays",
@@ -30,5 +34,5 @@
     "type": "git",
     "url": "https://github.com/creemama/utiljs/tree/master/packages/utiljs-arrays"
   },
-  "version": "0.41.6"
+  "version": "0.41.8"
 }

package/lib/Arrays.js

@@ -1,99 +0,0 @@
-"use strict";
-
-/**
- * JavaScript utility methods for [arrays]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array}
- * @public
- * @class
- */
-class Arrays {
-  /**
-   * Creates a new, shallow-copied Array instance from an array-like or iterable object.
-   *
-   * See MDN's documentation about [from]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/from}.
-   *
-   * @param arrayLike An array-like or iterable object to convert to an array
-   * @param {Function} [mapFn] Map function to call on every element of the array
-   * @param {Object} [thisArg] Value to use as this when executing mapFn
-   * @return {Array} A new Array instance
-   * @public
-   * @instance
-   * @function
-   */
-  from() {
-    return Array.from(...arguments);
-  }
-
-  /**
-   * Determines whether the passed value is an Array.
-   *
-   * See MDN's documentation about [isArray]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/isArray}.
-   *
-   * @param {*} obj The object to be checked
-   * @return {boolean} true if the object is an Array or false otherwise
-   * @public
-   * @instance
-   * @function
-   */
-  isArray() {
-    return Array.isArray(...arguments);
-  }
-
-  /**
-   * Creates a new Array instance with a variable number of arguments, regardless of number or type of the arguments
-   *
-   * See MDN's documentation about [of]{@link https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/of}.
-   *
-   * @param {...*} elementN Elements of which to create the array
-   * @return {Array} A new Array instance
-   * @public
-   * @instance
-   * @function
-   */
-  of() {
-    return Array.of(...arguments);
-  }
-
-  /**
-   * Shuffles the elements of the specified array.
-   *
-   * See [knuth-shuffle]{@link https://www.npmjs.com/package/knuth-shuffle}.
-   *
-   * @param {Array} array The array to shuffle
-   * @return {Array} A new Array instance
-   * @public
-   * @instance
-   * @function
-   */
-  shuffle(array) {
-    return knuthshuffle().knuthShuffle(this.from(array));
-  }
-
-  /**
-   * Sorts the elements of an array and (unlike returns a **new array** with the sorted elements. The default sort order is ascending, built upon converting the elements into strings, then comparing their sequences of UTF-16 code units values.
-   *
-   * See [knuth-shuffle]{@link https://www.npmjs.com/package/knuth-shuffle}.
-   *
-   * @param {Array} array The array to shuffle
-   * @return {Array} A new Array instance
-   * @public
-   * @instance
-   * @function
-   */
-  sort(array, compareFunction) {
-    // https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array/sort
-    // https://stackoverflow.com/questions/9592740/how-can-you-sort-an-array-without-mutating-the-original-array
-    // https://stackoverflow.com/a/9592755
-    return Array.prototype.slice.call(array).sort(compareFunction);
-  }
-}
-
-module.exports = Arrays;
-
-const dependencies = {};
-
-function knuthshuffle() {
-  return (
-    dependencies["knuth-shuffle"] ||
-    (dependencies["knuth-shuffle"] = require("knuth-shuffle"))
-  );
-}

package/test/ArraysTest.js

@@ -1,45 +0,0 @@
-"use strict";
-
-const arrays = require("..");
-const { expect } = require("chai");
-
-describe("Arrays", () => {
-  describe("#from", () => {
-    it("should create a shallow copy", () => {
-      const a = [1, 2, 3];
-      const b = arrays.from(a);
-      expect(b === a).to.be.false;
-      expect(b[0]).to.eql(1);
-      expect(b[1]).to.eql(2);
-      expect(b[2]).to.eql(3);
-      expect(b.length).to.eql(3);
-    });
-    it("should throw an error an undefined or null input", () => {
-      expect(() => arrays.from()).to.throw(Error);
-      expect(() => arrays.from(null)).to.throw(Error);
-    });
-  });
-
-  describe("#sort", () => {
-    it("should sort an array", () => {
-      const a = [2, 1, 3];
-      const b = arrays.sort(a);
-      expect(b).to.not.eql(a);
-      expect(b).to.eql([1, 2, 3]);
-    });
-  });
-
-  describe("#shuffle", () => {
-    it("should shuffle array contents", () => {
-      const a = [1, 2, 3];
-      const b = arrays.shuffle(a);
-      expect(b === a).to.be.false;
-      expect(b.length).to.eql(3);
-      // console.log(b)
-    });
-    it("should throw an error an undefined or null input", () => {
-      expect(() => arrays.shuffle()).to.throw(Error);
-      expect(() => arrays.shuffle(null)).to.throw(Error);
-    });
-  });
-});