@opndev/util 0.0.5 → 0.0.6

package/Changes

@@ -0,0 +1,32 @@
+Revision history for @opndev/util
+
+{{NEXT}}
+
+    * Maintainer release:
+        * Make use of gitlab pages for documenation
+    * Add none() function
+    * Add range() function
+    * Bugfix: Allow string values in pow_* functions
+
+0.0.5   2023-08-27 15:33:21-0400
+
+    * Include .mjs files in package
+
+0.0.4   2023-08-27 15:13:21-0400
+
+    * Add two mathematical functions:
+        * is_pow_of_two
+        * pow_of_two
+
+0.0.3       2021-11-12 17:15:02-0400
+
+    * maintainer release for ESM
+
+0.0.2       2020-05-15 16:19:23Z
+
+    * Allow any() to check for integers as well
+    * Update README.md
+
+0.0.1       2020-05-13 02:42:33Z
+
+    * First release

package/README.md

@@ -3,28 +3,7 @@
 This is a utility function package that tries to solve issues by keeping things
 DRY. It is an ESM package.
 
-## Exports
-
-This module exports two functions:
-
-* any(needle, haystack)
-* defined(something)
-
-##
-
-```
-import { any, defined } from '@opndev/util'
-
-let foo;
-if (defined(foo)) {
-  // do things
-}
-
-if (any('bar', ['foo', 'bar', 'baz'])) {
-  // do things
-}
-
-```
+[If you want to know more, have a look at our documenation](https://opndev.gitlab.io/javascript/opndev-js-util/)
 
 ## Development
 
@@ -32,11 +11,14 @@ Try to keep functions small and try not to depend on any outside functions. We
 aim to keep the dependency graph as small as possible. The use of `esm` is
 welcomed and writing tests is encouraged.
 
+### jsdoc
+
+You can build the documentation by running `npm run jsdoc`.
+
 ### eslint
 
 The ES Linting profile is flexible and does not try to enforce much. There is
-more than one way to do it:
-[TIMTOWTDI](https://en.wikipedia.org/wiki/There%27s_more_than_one_way_to_do_it)
+more than one way to do it ([TIMTOWTDI](https://en.wikipedia.org/wiki/There%27s_more_than_one_way_to_do_it)).
 
 Try to stay constistent, but forcing a programming style upon others is bad.
 
@@ -46,7 +28,7 @@ Please educate yourself and use a global gitignore file. Somes files will
 always be there. I'm looking at you `node_modules`.
 
 ### The lockfiles
-You'll also see that `package-lock.json` and/or `yarn.lock` is ignored. I
+You'll also see that `package-lock.json` and/or `yarn.lock` are ignored. I
 strongly believe that pinning packages lead to bit rot, as you never update
 packages. When a downstream module breaks its API you should know and update
 your code accordingly. The same goes for possible upstream modules. If you want

package/lib/any.mjs

@@ -3,22 +3,14 @@
  * a primitive. Objects tend to be harder. Use lodash instead.
  *
  * @function any
- * @params {*} needle Anything
- * @params {Array} haystack Anything
+ * @param {*} needle Anything
+ * @param {Array} haystack Anything
  * @returns {Boolean} true if needle is found, false otherwise
  */
-
-function _assert_array(haystack) {
-
-  if (Array.isArray(haystack))
-    return
-
-  throw "haystack is not an array";
-}
-
 export default function any(needle, haystack) {
 
-  _assert_array(haystack)
+  if (!Array.isArray(haystack))
+    throw "haystack is not an array";
 
   if (typeof needle === 'function')
     return haystack.some(needle)

package/lib/defined.mjs

@@ -1,7 +1,7 @@
 /**
  * Check if a variable is defined
  * @function defined
- * @params {*} what Anything really
+ * @param {*} what Anything really
  * @returns {Boolean} true if defined, false otherwise
  */
 

package/lib/index.mjs

@@ -1,9 +1,20 @@
 /**
+ *
+ * @module module:@opndev/utils
+ *
+ * @exports any
+ * @exports none
+ * @exports defined
+ * @exports pow_of_two
+ * @exports is_pow_of_two
+ *
  * Export all the useful functions. Unfortunatly, without webpack's
  * require.context we cannot automaticly load everything. So we just keep
  * typing. ES6 requires strict syntax on import and exports :/
  */
 export { any } from './any.mjs'
+export { none } from './none.mjs'
 export { defined } from './defined.mjs'
 export { pow_of_two } from './powtwo.mjs'
 export { is_pow_of_two } from './ispowtwo.mjs'
+export { range } from './range.mjs'

package/lib/ispowtwo.mjs

@@ -1,15 +1,21 @@
 /**
  * Check if something is the power of two
  * @function is_pow_of_two
- * @params {*} what an integer
+ * @param {Integer} what The number you want to validate as the power of two
  * @returns {Boolean} True is something is the power of two
+ *
+ * @example
+ * // A tournamen draw has to be a power of two
+ * if (is_pow_of_two(draw))
+ *  throw "A draw must be a power of two"
  */
 
 export default function is_pow_of_two(i) {
-  if (!Number.isInteger(i))
+  const parsed = Number.parseInt(i, 10);
+  if (Number.isNaN(parsed))
     throw new Error("Not a number");
 
-  return (!(i & (i-1)) && i) ? true : false;
+  return (!(parsed & (parsed-1)) && parsed) ? true : false;
 
 }
 

package/lib/none.mjs

@@ -0,0 +1,21 @@
+/**
+ * Check if a value is not preset in the given array, can be done via a
+ * function or a primitive.
+ *
+ * @function none
+ * @param {*} needle Anything
+ * @param {Array} haystack Anything
+ * @returns {Boolean} true if needle isnt found, false otherwise
+ */
+
+export default function none(needle, haystack) {
+  if (!Array.isArray(haystack))
+    throw "haystack is not an array";
+
+  if (typeof needle === 'function')
+    return haystack.some(needle) ? false : true
+
+  return haystack.includes(needle) ? false : true
+}
+
+export { none }

package/lib/powtwo.mjs

@@ -1,17 +1,24 @@
 /**
  * Returns the power of two
  * @function pow_of_two
- * @params {*} what an integer
+ * @param {*} what an integer
  * @returns {Integer} the power of two
+ *
+ * @example
+ * // Based on the amount of players you can extract how many rounds a
+ * tournament has (in single elimination
+ *
+ * const rounds = pow_of_two(players)
  */
 
 export default function pow_of_two(i) {
-  if (!Number.isInteger(i))
+  let parsed = Number.parseInt(i, 10);
+  if (Number.isNaN(parsed))
     throw new Error("Not a number");
 
   let count = 0;
-  while (i != 1) {
-    i = i >> 1;
+  while (parsed != 1) {
+    parsed = parsed >> 1;
     count++;
   }
   return count;

package/lib/range.mjs

@@ -0,0 +1,19 @@
+/**
+ * Return a range
+ * @function range
+ * @param start {Int}
+ * @param stop {Int}
+ * @returns {Array} An array with the requested values
+ */
+
+export default function range(start, stop, step = 1) {
+  return Array.from({
+    length: (stop - start) / step + 1
+  },
+  (_, i) => start + i * step
+  );
+}
+
+export {
+  range
+};

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "@opndev/util",
-  "version": "0.0.5",
+  "version": "0.0.6",
   "description": "Utility functions for OPN Development",
   "main": "lib/index.mjs",
+  "homepage": "https://opndev.gitlab.io/javascript/opndev-js-util/",
   "repository": {
-    "url": "git+https://gitlab.com/opndev/javascipt/opndev-js-util.git"
+    "url": "git+https://gitlab.com/opndev/javascript/opndev-js-util.git"
   },
   "bugs": {
     "url": "https://gitlab.com/opndev/javascript/opndev-js-util/issues"
@@ -12,7 +13,8 @@
   "type": "module",
   "mode": "auto",
   "scripts": {
-    "test": "tap"
+    "test": "tap",
+    "jsdoc" : "jsdoc -c jsdoc.json"
   },
   "author": {
     "name": "Wesley Schwengle",
@@ -21,10 +23,12 @@
   },
   "license": "MIT",
   "devDependencies": {
+    "jsdoc" : "latest",
     "tap": "latest"
   },
   "files": [
     "lib/*.mjs",
-    "README.md"
+    "README.md",
+    "Changes"
   ]
 }