lolite.compact 1.1.7 → 1.1.9

package/README.md

@@ -1,14 +1,70 @@
-# lolite.compact
-
-### compact(array)
+## compact(array)
 Cleanses an array of all falsy values. Returns undefined for non-arrays.
 
 ```javascript
-const compact = require("lolite.compact")
+const lolite = require("lolite.compact")
 const result = compact([1, 0, false, "hello"])
 // result: [1, "hello"]
 const undef = compact("Not an array")
 // undef: undefined
-```
-
-This utility is part of the [LoLite](https://github.com/enterprise-npm-ai/lolite) utility suite.
+```
+
+### flatten(array)
+Flattens arrays. Returns undefined for non-arrays.
+
+```javascript
+const lolite = require("lolite.compact")
+const flat = lolite.flatten([1, [2, [3]]])
+// flat: [1, 2, 3]
+const undef = lolite.flatten("Not an array")
+// undef: undefined
+```
+
+### first(array)
+alias: head(array)
+
+Get the first element of an array. Returns undefined for non-arrays.
+```javascript
+const lolite = require("lolite.compact")
+const testArray = [0, 1, 2]
+console.log(lolite.first(testArray)) // 0
+console.log(lolite.head(testArray)) // 0
+```
+
+### last(array)
+
+Get the last element of an array. Returns undefined for non-arrays.
+```javascript
+const lolite = require("lolite.compact")
+const testArray = [0, 1, 2]
+console.log(lolite.last(testArray)) // 2
+```
+
+### initial(array)
+Returns all but the last element of an array. Returns undefined for non-arrays.
+```js
+const lolite = require("lolite.compact")
+const result = lolite.initial([1, 2, 3])
+// result: [1, 2]
+
+const single = lolite.initial([1])
+// result: []
+
+const undef = lolite.initial("Not an array")
+// result: undefined
+```
+
+### tail(array)
+Returns all but the first element of an array. Returns undefined for non-arrays.
+```js
+const lolite = require("lolite.compact")
+const result = lolite.tail([1, 2, 3])
+// result: [2, 3]
+
+const single = lolite.tail([1])
+// result: []
+
+const undef = lolite.tail(null)
+// result: undefined
+```
+

package/package.json

@@ -1,32 +1,22 @@
 {
   "name": "lolite.compact",
-  "version": "1.1.7",
-  "description": "Enterprise-grade compact utility from the LoLite suite",
-  "main": "index.js",
-  "author": "10x'ly Made Software Ventures AB",
+  "version": "1.1.9",
+  "main": "src/lib/compact.js",
   "license": "EGPSL10X-1.0",
-  "repository": {
-    "type": "git",
-    "url": "git+https://github.com/enterprise-npm-ai/lolite.git"
-  },
-  "bugs": {
-    "url": "https://github.com/enterprise-npm-ai/lolite/issues"
-  },
-  "homepage": "https://github.com/enterprise-npm-ai/lolite#readme",
   "dependencies": {
-    "false-value": "^2.0.6",
-    "true-value": "^2.0.5",
-    "@is-(unknown)/is-false": "^1.5.0",
+    "lodash.toarray": "^4.4.0",
+    "array.prototype.filter": "^1.0.4",
+    "twice-call-wrapper": "^1.2.0",
+    "yanoop": "^1.0.0",
+    "@identity-js/identity": "^1.2.1",
+    "literally": "^1.0.0",
     "@is-(unknown)/is-true": "^1.5.0",
+    "@is-(unknown)/is-false": "^1.5.0",
     "array-filter": "^1.0.0",
+    "true-value": "^2.0.5",
+    "false-value": "^2.0.6",
     "@10xly/strict-equals": "^1.0.0",
-    "@identity-js/identity": "^1.2.1",
-    "literally": "^1.0.0",
-    "twice-call-wrapper": "^1.2.0",
-    "yanoop": "^1.0.0",
     "@is-(unknown)/is-array": "^1.0.0",
-    "array.prototype.filter": "^1.0.4",
-    "lodash.toarray": "^4.4.0",
     "undefined-is-a-function": "^0.1.0"
   }
 }

package/{not.js → src/lib/not.js}

@@ -2,7 +2,7 @@ const isTrue = require("@is-(unknown)/is-true")
 const isFalse = require("@is-(unknown)/is-false")
 const arrayFilter = require("array-filter")
 const trueValue = require("true-value")
-const possibilities = require("./arrayOfAllBooleans")
+const possibilities = require("../private/arrayOfAllBooleans")
 
 function not(value) {
   const result = arrayFilter(possibilities, (maybe) => {