knockout-collection - npm Package Compare versions

Comparing version 1.0.0 to 2.0.0

index.js

 define(['knockout'], function(ko) {
 
-  // Interface: http://www.doctrine-project.org/api/common/2.5/class-Doctrine.Common.Collections.Collection.html
   return function KnockoutCollection(items, options) {
     var that = this;
 
-    this.items = ko.observableArray(items);
+    if (options && options.reference === true) {
+      this.items = items;
+    } else {
+      this.items = ko.observableArray(items);
+    }
 
@@ -45,3 +48,3 @@ this.key = function(item) {
 
-    this.removeElement = function(item) {
+    this.remove = function(item) {
       var key = that.key(item);
@@ -58,6 +61,16 @@
 
+    this.removeAll = function() {
+      that.items.removeAll();
+    };
+
     this.toArray = function() {
       return that.items.slice();
     };
+
+    // initialize corerctly, because the first subscription will not be triggered
+    this.length = that.items().length;
+    that.items.subscribe(function(items) {
+      that.length = items.length;
+    });
   };
 });

package.json

 {
   "name": "knockout-collection",
-  "version": "1.0.0",
+  "version": "2.0.0",
   "description": "A knockout observable array as hashmap",
   "main": "index.js",
   "scripts": {
-    "test": "echo \"Error: no test specified\" && exit 1"
+    "test": "mocha tests/js/mocha"
   },
@@ -24,3 +24,11 @@ "repository": {
   },
-  "homepage": "https://github.com/webforge-labs/knockout-collection#readme"
+  "homepage": "https://github.com/webforge-labs/knockout-collection#readme",
+  "devDependencies": {
+    "chai": "^3.4.1",
+    "knockout": "^3.4.0",
+    "requirejs": "^2.1.22"
+  },
+  "dependencies": {
+    "knockout-mapping": "^2.5.0"
+  }
 }

README.md

@@ -1,2 +0,86 @@
-# knockout-collection
+
+
+# knockout-collection [![Build Status](https://travis-ci.org/webforge-labs/knockout-collection.svg?branch=master)](https://travis-ci.org/webforge-labs/knockout-collection)
+
 A knockout observable array as hashmap
+
+## usage
+
+```js
+var item1 = {
+  id: ko.observable(1),
+  label: 'Item 1'
+};
+
+var item2 = {
+  id: ko.observable(2),
+  label: 'Item 2'
+}
+
+var collection = new KnockoutCollection([item1], { key: 'id' });
+
+expect(collection.get(2)).to.be.undefined;
+
+collection.add(item2);
+
+expect(collection.get(2)).to.have.property('label', 'Item 2');
+
+collection.remove(item1);
+collection.remove(item2);
+
+expect(collection.toArray()).to.have.length(0);
+```
+
+## api
+
+If you need direct access to the underlying `ko.observableArray` you can use `collection.items`. Use this only to bind, not to modify.
+
+### construction
+
+You can pass an array as items.
+```js
+new KnockoutCollection(['my', 'array', 'items']);
+```
+
+If you want to manage an `ko.observableArray` you can pass it as `items` and set the option: `reference`:
+
+```js
+var items = ko.observableArray([item1, item2]);
+var collection = new KnockoutCollection(items, { key: 'id', reference: true });
+
+collection.remove(item1);
+
+// items() will be [item2]
+```
+
+#### .add(item)
+
+adds an item to the collection which is identified by the value of the (observable-)property with name `options.key`.  
+**The item is only added, if it isn't already contained in the collection**
+
+#### .remove(item)
+
+removes the item from the collection. If it isnt available in the collection nothing is done
+
+#### .get(keyValue)
+
+returns the item with the value of the (observable-)property with name `options.key` equal to `keyValue`.  
+it will return `undefined` if the collection does not contain the item.
+
+#### .contains(item)
+
+checks if the item is contained in the collection.
+
+#### .length
+
+You can use the length property as you would use it for an array:
+
+```js
+var collection = new KnockoutCollection(['i1', 'i2']);
+
+console.log(collection.length === 2); // is true
+```
+
+#### .removeAll()
+
+Removes all items from the collection

New alerts

Dynamic require

Supply chain risk

Dynamic require can indicate the package is performing dangerous or unsafe dynamic code execution.

Found 1 instance in 1 package

Fixed alerts

No tests

Quality

Package does not have any tests. This is a strong signal of a poorly maintained or low quality package.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

10691

increased by184.34%

Number of package files

8

increased by60%

Lines of code

173

increased by260.42%

Number of low quality alerts

0

decreased by-100%

Number of lines in readme file

86

increased by2766.67%

Worsened metrics

Dependency count

1

increased byInfinity%

Dev dependency count

3

increased byInfinity%

Number of low supply chain risk alerts

1

increased byInfinity%

Dependency changes

• + Addedknockout-mapping@^2.5.0

• + Addedknockout@3.5.1(transitive)

• + Addedknockout-mapping@2.6.0(transitive)