- Modified palette method to use options argument.

- Modified findContrast method to use options argument.
- Updated tests.
- Updated README.
- Updated NPM.

Author: elusivecodes

README.md

@@ -397,12 +397,13 @@ const colorTones = color.tones(tones);
 
 Create a palette object with a specified number of shades, tints and tone variations.
 
-- `shades` is a number indicating how many shades you wish to generate, and will default to *10*.
-- `tints` is a number indicating how many tints you wish to generate, and will default to *10*.
-- `tones` is a number indicating how many tones you wish to generate, and will default to *10*.
+- `options` is an object containing options for how the palette should be generated.
+    - `shades` is a number indicating how many shades you wish to generate, and will default to *10*.
+    - `tints` is a number indicating how many tints you wish to generate, and will default to *10*.
+    - `tones` is a number indicating how many tones you wish to generate, and will default to *10*.
 
 ```javascript
-const colorPalette = color.palette(shades, tints, tones);
+const colorPalette = color.palette(options);
 ```
 
 
@@ -436,8 +437,9 @@ Find an optimally contrasting color for another color.
 
 - `color1` is a *Color* object.
 - `color2` is a *Color* object, and will default to *null*.
-- `minContrast` is a number between *1* and *21* indicating the minimum valid contrast, and will default to *4.5*.
-- `stepSize` is a number between *0* and *1* indicating the amount to darken/lighten the color on each iteration, and will default to *0.01*.
+- `options` is an object containing options for how the contrasting color should be found.
+    - `minContrast` is a number between *1* and *21* indicating the minimum valid contrast, and will default to *4.5*.
+    - `stepSize` is a number between *0* and *1* indicating the amount to darken/lighten the color on each iteration, and will default to *0.01*.
 
 ```javascript
 const contrastColor = Color.findContrast(color1, color2, minContrast, stepSize);

dist/frost-color.js

@@ -1,6 +1,6 @@
 {
     "name": "@fr0st/color",
-    "version": "4.0.2",
+    "version": "4.1.0",
     "description": "FrostColor is a free, open-source color manipulation library for JavaScript.",
     "keywords": [
         "color",
@@ -40,10 +40,10 @@
     "license": "MIT",
     "private": false,
     "devDependencies": {
-        "eslint": "^8.31.0",
+        "eslint": "^8.41.0",
         "eslint-config-google": "^0.14.0",
         "mocha": "^10.2.0",
-        "rollup": "^3.9.1",
-        "terser": "^5.16.1"
+        "rollup": "^3.22.0",
+        "terser": "^5.17.4"
     }
 }

dist/frost-color.js.map

@@ -4,12 +4,13 @@
 
 /**
  * Create a palette object with a specified number of shades, tints and tone variations.
- * @param {number} [shades=10] The number of shades to generate.
- * @param {number} [tints=10] The number of tints to generate.
- * @param {number} [tones=10] The number of tones to generate.
+ * @param {object} [options] The options for generating a palette.
+ * @param {number} [options.shades=10] The number of shades to generate.
+ * @param {number} [options.tints=10] The number of tints to generate.
+ * @param {number} [options.tones=10] The number of tones to generate.
  * @return {object} A palette object.
  */
-export function palette(shades = 10, tints = 10, tones = 10) {
+export function palette({ shades = 10, tints = 10, tones = 10 } = {}) {
     return {
         shades: this.shades(shades),
         tints: this.tints(tints),

dist/frost-color.min.js

@@ -32,11 +32,12 @@ export const dist = (color1, color2) => {
  * Find an optimally contrasting color for another color.
  * @param {Color} color1 The first Color.
  * @param {Color} [color2] The second Color.
- * @param {number} [minContrast=4.5] The minimum contrast.
- * @param {number} [stepSize=.01] The step size.
+ * @param {object} [options] The options for finding the contrasting color.
+ * @param {number} [options.minContrast=4.5] The minimum contrast.
+ * @param {number} [options.stepSize=.01] The step size.
  * @return {Color} The new Color.
  */
-export const findContrast = (color1, color2 = null, minContrast = 4.5, stepSize = .01) => {
+export const findContrast = (color1, color2 = null, { minContrast = 4.5, stepSize = .01 } = {}) => {
     if (!color2) {
         color2 = color1;
     }

dist/frost-color.min.js.map

@@ -239,7 +239,7 @@ describe('Color Palette', function() {
 
         it('works with shades argument', function() {
             const palette = Color.fromHSV(120, 50, 50)
-                .palette(5, 0, 0);
+                .palette({ shades: 5 });
 
             assert.deepStrictEqual(
                 palette.shades.map(
@@ -256,11 +256,11 @@ describe('Color Palette', function() {
 
             assert.strictEqual(
                 palette.tints.length,
-                0
+                10
             );
             assert.strictEqual(
                 palette.tones.length,
-                0
+                10
             );
             assert.ok(
                 palette.shades.every(
@@ -271,7 +271,7 @@ describe('Color Palette', function() {
 
         it('works with tints argument', function() {
             const palette = Color.fromHSV(120, 50, 50)
-                .palette(0, 5, 0);
+                .palette({ tints: 5 });
 
             assert.deepStrictEqual(
                 palette.tints.map(
@@ -288,11 +288,11 @@ describe('Color Palette', function() {
 
             assert.strictEqual(
                 palette.shades.length,
-                0
+                10
             );
             assert.strictEqual(
                 palette.tones.length,
-                0
+                10
             );
             assert.ok(
                 palette.tints.every(
@@ -303,7 +303,7 @@ describe('Color Palette', function() {
 
         it('works with tones argument', function() {
             const palette = Color.fromHSV(120, 50, 50)
-                .palette(0, 0, 5);
+                .palette({ tones: 5 });
 
             assert.deepStrictEqual(
                 palette.tones.map(
@@ -320,11 +320,11 @@ describe('Color Palette', function() {
 
             assert.strictEqual(
                 palette.shades.length,
-                0
+                10
             );
             assert.strictEqual(
                 palette.tints.length,
-                0
+                10
             );
             assert.ok(
                 palette.tones.every(