election-utils - npm Package Compare versions

Comparing version 3.2.0 to 3.2.1

build/index.es6.js

@@ -33,3 +33,3 @@ import orderBy from 'lodash.orderby';
 	"party": "republican",
-	"suspendedDate": "2016-02-19"
+	"suspendedDate": "2016-02-20"
 }, {
@@ -36,0 +36,0 @@ "last": "carson",

build/index.js

@@ -37,3 +37,3 @@ 'use strict';
 	"party": "republican",
-	"suspendedDate": "2016-02-19"
+	"suspendedDate": "2016-02-20"
 }, {
@@ -40,0 +40,0 @@ "last": "carson",

doc.md

@@ -44,3 +44,3 @@ # Candidate
 
--   `candidates` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** an array of Candidates
+-   `candidates` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** an array of Candidates
 
@@ -55,2 +55,23 @@ **Examples**
 
+## makeColorMappings
+
+Map candidates to color classes.
+Useful for coloring choropleths.
+
+**Parameters**
+
+-   `$0.candidates` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** an array of Candidates
+-   `$1.party` **[String](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/String)** the Candidates' party
+-   `$2.mainCandidates` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** an array of main Candidates
+-   `_ref`  
+
+**Examples**
+
+```javascript
+const m = Candidates.makeColorMappings({ candidates, party, mainCandidates })
+m[0] //=> { colorClass: 'democratic-0', candidateID: '123' }
+```
+
+Returns **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** an array of objects containing `colorClass` and `candidateID`
+
 ## sort
@@ -62,3 +83,3 @@
 
--   `candidates` **[Object](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Object)** an array of Candidates
+-   `candidates` **[Array](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Array)** an array of Candidates
 
@@ -65,0 +86,0 @@ **Examples**

package.json

 {
   "name": "election-utils",
-  "version": "3.2.0",
+  "version": "3.2.1",
   "description": "This module provides various utility functions for dealing with AP election data.",
@@ -5,0 +5,0 @@ "main": "build/index.js",

src/util/primaries2016Candidates.js

@@ -13,3 +13,3 @@ /**
 		"party": "republican",
-		"suspendedDate": "2016-02-19"
+		"suspendedDate": "2016-02-20"
 	},
@@ -16,0 +16,0 @@ {

No alert changes

Improved metrics

Total package byte prevSize

74821

increased by1.21%

No dependency changes