Merge pull request #109 from dhershman1/development

Development
dhershman1 · Apr 24, 2019 · 92524aa · 92524aa
2 parents 016006d + 0c3924b
commit 92524aa
Show file tree

Hide file tree

Showing 157 changed files with 2,361 additions and 1,752 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,5 +1,16 @@
 # Changelog
 
+## v0.12.2
+
+### New
+
+- Added `propEq` function which takes a object property value and compares it against a given value to see if it's equal
+- Added `notEq` function which checks if the provided values are not equal to each other
+
+### Fixed
+
+- The documentation for `and` should now reflect correctly on the return and params
+
 ## v0.12.1
 
 ### Fixed

diff --git a/dist/kyanite.js b/dist/kyanite.js
@@ -859,6 +859,11 @@
   };
   var memoizeWith$1 = _curry2(memoizeWith);
 
+  var notEq = function notEq(a, b) {
+    return complement$1(eq$1(a), b);
+  };
+  var notEq$1 = _curry2(notEq);
+
   var or = function or(a, b) {
     return a || b;
   };
@@ -1132,6 +1137,11 @@
   };
   var prop$1 = _curry2(prop);
 
+  var propEq = function propEq(key, val, obj) {
+    return compose$1(eq$1(val), prop$1(key), obj);
+  };
+  var propEq$1 = _curry3(propEq);
+
   var props = function props(keys, obj) {
     return map$1(function (k) {
       return obj[k];
@@ -1304,6 +1314,7 @@
   exports.multiply = multiply$1;
   exports.negate = negate;
   exports.not = not;
+  exports.notEq = notEq$1;
   exports.nth = nth$1;
   exports.omit = omit$1;
   exports.on = on$1;
@@ -1319,6 +1330,7 @@
   exports.prepend = prepend$1;
   exports.product = product;
   exports.prop = prop$1;
+  exports.propEq = propEq$1;
   exports.props = props$1;
   exports.range = range$1;
   exports.reduce = reduce$1;

diff --git a/dist/kyanite.min.js b/dist/kyanite.min.js
diff --git a/docs/array_chunk.js.html b/docs/array_chunk.js.html
diff --git a/docs/array_concatMap.js.html b/docs/array_concatMap.js.html
diff --git a/docs/array_countBy.js.html b/docs/array_countBy.js.html
diff --git a/docs/array_difference.js.html b/docs/array_difference.js.html
diff --git a/docs/array_drop.js.html b/docs/array_drop.js.html
diff --git a/docs/array_dropWhile.js.html b/docs/array_dropWhile.js.html
diff --git a/docs/array_ensureArray.js.html b/docs/array_ensureArray.js.html
diff --git a/docs/array_every.js.html b/docs/array_every.js.html
diff --git a/docs/array_everyPass.js.html b/docs/array_everyPass.js.html
diff --git a/docs/array_filter.js.html b/docs/array_filter.js.html
diff --git a/docs/array_find.js.html b/docs/array_find.js.html
diff --git a/docs/array_findIndex.js.html b/docs/array_findIndex.js.html
diff --git a/docs/array_groupBy.js.html b/docs/array_groupBy.js.html
diff --git a/docs/array_insert.js.html b/docs/array_insert.js.html
diff --git a/docs/array_intersection.js.html b/docs/array_intersection.js.html
diff --git a/docs/array_juxt.js.html b/docs/array_juxt.js.html
diff --git a/docs/array_map.js.html b/docs/array_map.js.html
diff --git a/docs/array_max.js.html b/docs/array_max.js.html
diff --git a/docs/array_maxBy.js.html b/docs/array_maxBy.js.html
diff --git a/docs/array_min.js.html b/docs/array_min.js.html
diff --git a/docs/array_minBy.js.html b/docs/array_minBy.js.html
diff --git a/docs/array_partition.js.html b/docs/array_partition.js.html
diff --git a/docs/array_prepend.js.html b/docs/array_prepend.js.html
diff --git a/docs/array_reduceRight.js.html b/docs/array_reduceRight.js.html
diff --git a/docs/array_reject.js.html b/docs/array_reject.js.html
diff --git a/docs/array_remove.js.html b/docs/array_remove.js.html
diff --git a/docs/array_some.js.html b/docs/array_some.js.html
diff --git a/docs/array_somePass.js.html b/docs/array_somePass.js.html
diff --git a/docs/array_sort.js.html b/docs/array_sort.js.html
diff --git a/docs/array_sortBy.js.html b/docs/array_sortBy.js.html
diff --git a/docs/array_sortWith.js.html b/docs/array_sortWith.js.html
diff --git a/docs/array_take.js.html b/docs/array_take.js.html
diff --git a/docs/array_takeWhile.js.html b/docs/array_takeWhile.js.html
diff --git a/docs/array_union.js.html b/docs/array_union.js.html
diff --git a/docs/array_uniq.js.html b/docs/array_uniq.js.html
diff --git a/docs/array_uniqBy.js.html b/docs/array_uniqBy.js.html
diff --git a/docs/array_update.js.html b/docs/array_update.js.html
diff --git a/docs/array_zip.js.html b/docs/array_zip.js.html
diff --git a/docs/function_addIndex.js.html b/docs/function_addIndex.js.html
diff --git a/docs/function_always.js.html b/docs/function_always.js.html
diff --git a/docs/function_and.js.html b/docs/function_and.js.html
diff --git a/docs/function_ap.js.html b/docs/function_ap.js.html
diff --git a/docs/function_apply.js.html b/docs/function_apply.js.html
diff --git a/docs/function_ascend.js.html b/docs/function_ascend.js.html
diff --git a/docs/function_ascendBy.js.html b/docs/function_ascendBy.js.html
diff --git a/docs/function_both.js.html b/docs/function_both.js.html
diff --git a/docs/function_branch.js.html b/docs/function_branch.js.html
diff --git a/docs/function_complement.js.html b/docs/function_complement.js.html
diff --git a/docs/function_compose.js.html b/docs/function_compose.js.html
diff --git a/docs/function_composeP.js.html b/docs/function_composeP.js.html
diff --git a/docs/function_count.js.html b/docs/function_count.js.html
diff --git a/docs/function_curry.js.html b/docs/function_curry.js.html
diff --git a/docs/function_curryN.js.html b/docs/function_curryN.js.html
diff --git a/docs/function_deepEq.js.html b/docs/function_deepEq.js.html
diff --git a/docs/function_defaultTo.js.html b/docs/function_defaultTo.js.html
diff --git a/docs/function_descend.js.html b/docs/function_descend.js.html
diff --git a/docs/function_descendBy.js.html b/docs/function_descendBy.js.html
diff --git a/docs/function_either.js.html b/docs/function_either.js.html
diff --git a/docs/function_encase.js.html b/docs/function_encase.js.html
diff --git a/docs/function_eq.js.html b/docs/function_eq.js.html
diff --git a/docs/function_eqBy.js.html b/docs/function_eqBy.js.html
diff --git a/docs/function_flip.js.html b/docs/function_flip.js.html
diff --git a/docs/function_gt.js.html b/docs/function_gt.js.html
diff --git a/docs/function_gte.js.html b/docs/function_gte.js.html
diff --git a/docs/function_has.js.html b/docs/function_has.js.html
diff --git a/docs/function_identity.js.html b/docs/function_identity.js.html
diff --git a/docs/function_isEmpty.js.html b/docs/function_isEmpty.js.html
diff --git a/docs/function_isNil.js.html b/docs/function_isNil.js.html
diff --git a/docs/function_lt.js.html b/docs/function_lt.js.html
diff --git a/docs/function_lte.js.html b/docs/function_lte.js.html
diff --git a/docs/function_memoizeWith.js.html b/docs/function_memoizeWith.js.html
diff --git a/docs/function_not.js.html b/docs/function_not.js.html
diff --git a/docs/function_notEq.js.html b/docs/function_notEq.js.html
@@ -0,0 +1,108 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+
+    <meta charset="utf-8">
+    <title>function/notEq.js - Documentation</title>
+
+    <meta name="description" content="A small library of pure functional utilities to make life easier and data better" />
+
+        <meta name="keywords" content="functional, library, javascript, pure, helpers, utils" />
+        <meta name="keyword" content="functional, library, javascript, pure, helpers, utils" />
+
+
+
+    <script src="scripts/prettify/prettify.js"></script>
+    <script src="scripts/prettify/lang-css.js"></script>
+    <!--[if lt IE 9]>
+      <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+    <![endif]-->
+    <link type="text/css" rel="stylesheet" href="styles/prettify.css">
+    <link type="text/css" rel="stylesheet" href="styles/jsdoc.css">
+    <meta name="viewport" content="width=device-width, initial-scale=1.0">
+</head>
+<body>
+
+<input type="checkbox" id="nav-trigger" class="nav-trigger" />
+<label for="nav-trigger" class="navicon-button x">
+  <div class="navicon"></div>
+</label>
+
+<label for="nav-trigger" class="overlay"></label>
+
+<nav>
+
+    <input type="text" id="nav-search" placeholder="Search" />
+
+    <h2><a href="index.html">Home</a></h2><h2><a href="https://github.com/dhershman1/kyanite" target="_blank" class="menu-item" id="repository" >Github repo</a></h2><ul class="nav-list"><h3>Number</h3><li class="nav-item" data-cat="Number"><a href="functions.html#add">add</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#between">between</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#clamp">clamp</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#dec">dec</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#divide">divide</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#factors">factors</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#gcd">gcd</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#inc">inc</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#isEven">isEven</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#isOdd">isOdd</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#isPrime">isPrime</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#isZero">isZero</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#lcm">lcm</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#mean">mean</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#median">median</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#mod">mod</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#multiply">multiply</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#negate">negate</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#pow">pow</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#product">product</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#range">range</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#rem">rem</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#round">round</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#subtract">subtract</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#sum">sum</a></li><li class="nav-item" data-cat="Number"><a href="functions.html#within">within</a></li><h3>Function</h3><li class="nav-item" data-cat="Function"><a href="functions.html#addIndex">addIndex</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#always">always</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#and">and</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#ap">ap</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#apply">apply</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#ascend">ascend</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#ascendBy">ascendBy</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#both">both</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#branch">branch</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#complement">complement</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#compose">compose</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#composeP">composeP</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#count">count</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#curry">curry</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#curryN">curryN</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#deepEq">deepEq</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#defaultTo">defaultTo</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#descend">descend</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#descendBy">descendBy</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#either">either</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#encase">encase</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#eq">eq</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#eqBy">eqBy</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#flip">flip</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#gt">gt</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#gte">gte</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#has">has</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#identity">identity</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#isEmpty">isEmpty</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#isNil">isNil</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#lt">lt</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#lte">lte</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#memoizeWith">memoizeWith</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#not">not</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#notEq">notEq</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#on">on</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#or">or</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#pipe">pipe</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#pipeP">pipeP</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#reduce">reduce</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#reduced">reduced</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#reject">reject</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#size">size</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#type">type</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#unless">unless</a></li><li class="nav-item" data-cat="Function"><a href="functions.html#when">when</a></li><h3>Object</h3><li class="nav-item" data-cat="Object"><a href="functions.html#amend">amend</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#any">any</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#draft">draft</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#height">height</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#omit">omit</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#over">over</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#path">path</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#pathOr">pathOr</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#plan">plan</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#prop">prop</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#propEq">propEq</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#props">props</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#sift">sift</a></li><li class="nav-item" data-cat="Object"><a href="functions.html#whole">whole</a></li><h3>String</h3><li class="nav-item" data-cat="String"><a href="functions.html#capitalize">capitalize</a></li><li class="nav-item" data-cat="String"><a href="functions.html#fuzzySearch">fuzzySearch</a></li><li class="nav-item" data-cat="String"><a href="functions.html#join">join</a></li><li class="nav-item" data-cat="String"><a href="functions.html#match">match</a></li><li class="nav-item" data-cat="String"><a href="functions.html#replace">replace</a></li><li class="nav-item" data-cat="String"><a href="functions.html#split">split</a></li><li class="nav-item" data-cat="String"><a href="functions.html#test">test</a></li><li class="nav-item" data-cat="String"><a href="functions.html#toLower">toLower</a></li><li class="nav-item" data-cat="String"><a href="functions.html#toUpper">toUpper</a></li><li class="nav-item" data-cat="String"><a href="functions.html#trim">trim</a></li><h3>Array</h3><li class="nav-item" data-cat="Array"><a href="functions.html#chunk">chunk</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#concatMap">concatMap</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#countBy">countBy</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#difference">difference</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#drop">drop</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#dropWhile">dropWhile</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#ensureArray">ensureArray</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#every">every</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#everyPass">everyPass</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#filter">filter</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#find">find</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#findIndex">findIndex</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#groupBy">groupBy</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#insert">insert</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#intersection">intersection</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#juxt">juxt</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#length">length</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#map">map</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#max">max</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#maxBy">maxBy</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#min">min</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#minBy">minBy</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#partition">partition</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#prepend">prepend</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#reduceRight">reduceRight</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#remove">remove</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#some">some</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#somePass">somePass</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#sort">sort</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#sortBy">sortBy</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#sortWith">sortWith</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#take">take</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#takeWhile">takeWhile</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#union">union</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#uniq">uniq</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#uniqBy">uniqBy</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#update">update</a></li><li class="nav-item" data-cat="Array"><a href="functions.html#zip">zip</a></li><h3>List</h3><li class="nav-item" data-cat="List"><a href="functions.html#concat">concat</a></li><li class="nav-item" data-cat="List"><a href="functions.html#endsWith">endsWith</a></li><li class="nav-item" data-cat="List"><a href="functions.html#first">first</a></li><li class="nav-item" data-cat="List"><a href="functions.html#includes">includes</a></li><li class="nav-item" data-cat="List"><a href="functions.html#last">last</a></li><li class="nav-item" data-cat="List"><a href="functions.html#nth">nth</a></li><li class="nav-item" data-cat="List"><a href="functions.html#reverse">reverse</a></li><li class="nav-item" data-cat="List"><a href="functions.html#slice">slice</a></li></ul>
+</nav>
+
+<div id="main">
+
+    <h1 class="page-title">function/notEq.js</h1>
+
+
+
+
+
+
+
+    <section>
+        <article>
+            <pre class="prettyprint source linenums"><code>import _curry2 from '../_internals/_curry2'
+import complement from './complement'
+import eq from './eq'
+
+/**
+ * @name notEq
+ * @function
+ * @since v0.12.2
+ * @category Function
+ * @sig * -> * -> Boolean
+ * @description Takes in two values and checks to make sure they're not equal to each other
+ * @param {Any} a The first value to compare
+ * @param {Any} b The second value to compare
+ * @return {Boolean} Whether or not the values provided are equal
+ * @example
+ * import { notEq } from 'kyanite'
+ *
+ * notEq(1, '1') // => true
+ * notEq('test', 'Test') // => true
+ * notEq(2, 2) // => false
+ *
+ * // It's also curried
+ *
+ * const fn = notEq(1)
+ *
+ * fn('1') // => true
+ * fn(2) // => true
+ * fn(1) // => false
+ */
+const notEq = (a, b) => complement(eq(a), b)
+
+export default _curry2(notEq)
+</code></pre>
+        </article>
+    </section>
+
+
+
+
+
+
+</div>
+
+<br class="clear">
+
+<footer>
+    Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 3.5.5</a> using the <a href="https://github.com/clenemt/docdash">docdash</a> theme.
+</footer>
+
+<script>prettyPrint();</script>
+<script src="scripts/linenumber.js"></script>
+
+<script src="scripts/search.js"></script>
+
+
+</body>
+</html>