Merge branch 'release/4.33.0'

ecrmnn · Apr 27, 2022 · 9964bc6 · 9964bc6
2 parents 2ab3ed6 + 88e6c52
commit 9964bc6
Show file tree

Hide file tree

Showing 10 changed files with 112 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -51,6 +51,7 @@ All available methods
 - [combine](#combine)
 - [concat](#concat)
 - [contains](#contains)
+- [containsOneItem](#containsoneitem)
 - [count](#count)
 - [countBy](#countby)
 - [crossJoin](#crossjoin)
@@ -379,6 +380,37 @@ collection.contains((value, key) => value > 5);
 // false
 ```
 
+#### `containsOneItem()`
+
+The containsOneItem method returns true if the collection contains exactly one item; otherwise, false is returned:
+
+```js
+collect([1]).containsOneItem();
+// true
+
+collect({ firstname: 'Luis' }).containsOneItem();
+// true
+
+collect('value').containsOneItem();
+// true
+
+collect([1, 2, 3]).containsOneItem();
+//  false
+
+collect({ firstname: 'Luis', lastname: 'Díaz' }).containsOneItem();
+// false
+
+collect().containsOneItem();
+// false
+
+collect([]).containsOneItem();
+// false
+
+collect({}).containsOneItem();
+// false
+```
+
+
 #### `count()`
 
 The count method returns the total number of items in the collection:

diff --git a/build/collect.js b/build/collect.js
diff --git a/build/collect.min.js b/build/collect.min.js
diff --git a/dist/index.js b/dist/index.js
@@ -38,6 +38,7 @@ Collection.prototype.collapse = require('./methods/collapse');
 Collection.prototype.combine = require('./methods/combine');
 Collection.prototype.concat = require('./methods/concat');
 Collection.prototype.contains = require('./methods/contains');
+Collection.prototype.containsOneItem = require('./methods/containsOneItem');
 Collection.prototype.count = require('./methods/count');
 Collection.prototype.countBy = require('./methods/countBy');
 Collection.prototype.crossJoin = require('./methods/crossJoin');

diff --git a/dist/methods/containsOneItem.js b/dist/methods/containsOneItem.js
@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = function containsOneItem() {
+  return this.count() === 1;
+};
diff --git a/docs/api/containsOneItem.md b/docs/api/containsOneItem.md
@@ -0,0 +1,31 @@
+# `containsOneItem()`
+
+The containsOneItem method returns true if the collection contains exactly one item; otherwise, false is returned:
+
+```js
+collect([1]).containsOneItem();
+// true
+
+collect({ firstname: 'Luis' }).containsOneItem();
+// true
+
+collect('value').containsOneItem();
+// true
+
+collect([1, 2, 3]).containsOneItem();
+//  false
+
+collect({ firstname: 'Luis', lastname: 'Díaz' }).containsOneItem();
+// false
+
+collect().containsOneItem();
+// false
+
+collect([]).containsOneItem();
+// false
+
+collect({}).containsOneItem();
+// false
+```
+
+[View source on GitHub](https://github.com/ecrmnn/collect.js/blob/master/src/methods/containsOneItem.js)
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "collect.js",
-  "version": "4.32.0",
+  "version": "4.33.0",
   "description": "Convenient and dependency free wrapper for working with arrays and objects.",
   "main": "dist/index.js",
   "typings": "index.d.ts",

diff --git a/src/index.js b/src/index.js
@@ -36,6 +36,7 @@ Collection.prototype.collapse = require('./methods/collapse');
 Collection.prototype.combine = require('./methods/combine');
 Collection.prototype.concat = require('./methods/concat');
 Collection.prototype.contains = require('./methods/contains');
+Collection.prototype.containsOneItem = require('./methods/containsOneItem');
 Collection.prototype.count = require('./methods/count');
 Collection.prototype.countBy = require('./methods/countBy');
 Collection.prototype.crossJoin = require('./methods/crossJoin');

diff --git a/src/methods/containsOneItem.js b/src/methods/containsOneItem.js
@@ -0,0 +1,5 @@
+'use strict';
+
+module.exports = function containsOneItem() {
+  return this.count() === 1;
+};
diff --git a/test/methods/containsOneItem_test.js b/test/methods/containsOneItem_test.js
@@ -0,0 +1,22 @@
+'use strict';
+
+module.exports = (it, expect, collect) => {
+  it('should test if collection contains one item', () => {
+    expect(collect().containsOneItem()).to.eql(false);
+    expect(collect([]).containsOneItem()).to.eql(false);
+    expect(collect({}).containsOneItem()).to.eql(false);
+
+    expect(collect([1]).containsOneItem()).to.eql(true);
+    expect(collect('').containsOneItem()).to.eql(true);
+    expect(collect('xo').containsOneItem()).to.eql(true);
+    expect(collect(['']).containsOneItem()).to.eql(true);
+    expect(collect('a', 'b').containsOneItem()).to.eql(true);
+    expect(collect('value').containsOneItem()).to.eql(true);
+    expect(collect(['value']).containsOneItem()).to.eql(true);
+    expect(collect({ key: 'value' }).containsOneItem()).to.eql(true);
+
+    expect(collect([1, 2, 3]).containsOneItem()).to.eql(false);
+    expect(collect({ key: 'value', value: 'key' }).containsOneItem()).to.eql(false);
+    expect(collect([{ key: 'value' }, { key: 'value' }]).containsOneItem()).to.eql(false);
+  });
+};