@thi.ng/color 5.6.24 → 5.6.25

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-23T15:42:39Z
+- **Last updated**: 2024-02-25T14:07:53Z
 - **Generator**: [thi.ng/monopub](https://thi.ng/monopub)
 
 All notable changes to this project will be documented in this file.

package/color-range.d.ts

@@ -55,6 +55,8 @@ export declare function colorsFromRange(range: ColorRange | keyof typeof COLOR_R
  *
  * @example
  * ```ts
+ * import { colorsFromTheme } from "@thi.ng/color";
+ *
  * [...colorsFromTheme(
  *   [["cool", "aliceblue"], ["bright", "orange", 0.25], ["hotpink", 0.1]],
  *   { num: 10 }

package/color.d.ts

@@ -6,6 +6,8 @@ import type { Color, ColorMode, ParsedColor, TypedColor } from "./api.js";
  *
  * @example
  * ```ts
+ * import { color } from "@thi.ng/color";
+ *
  * color("springgreen");
  * // $Color [srgb] { offset: 0, stride: 1, buf: [ 0, 1, 0.498, 1 ] }
  *

package/cosine-gradients.d.ts

@@ -67,12 +67,14 @@ export declare const cosineCoeffs: FnU2<ReadonlyColor, CosGradientSpec>;
  *
  * @example
  * ```ts
+ * import { multiCosineGradient, srgb } from "@thi.ng/color";
+ *
  * multiCosineGradient({
  *   num: 10,
  *   // gradient stops (normalized positions)
  *   stops: [[0.1, [1, 0, 0, 1]], [0.5, [0, 1, 0, 1]], [0.9, [0, 0, 1, 1]]],
  *   // optional color transform/coercion
- *   tx: srgba
+ *   tx: srgb
  * })
  * ```
  *

package/gradients.d.ts

@@ -14,9 +14,13 @@ import type { GradientOpts } from "./api/gradients.js";
  *
  * @example
  * ```ts
+ * import { lch, multiColorGradient, swatchesH } from "@thi.ng/color";
+ * import { serialize } from "@thi.ng/hiccup";
+ * import { svg } from "@thi.ng/hiccup-svg";
+ *
  * gradient = multiColorGradient({
  *   num: 100,
- *   // LAB color stops
+ *   // LCH color stops
  *   stops: [
  *     // pink red
  *     [0, lch(0.8, 0.8, 0)],
@@ -31,10 +35,10 @@ import type { GradientOpts } from "./api/gradients.js";
  *
  * // write gradient as SVG swatches
  * writeFileSync(
- *   `export/lch-multigradient.svg`,
+ *   `lch-multigradient.svg`,
  *   serialize(
  *     svg(
- *       { width: 500, height: 50, convert: true },
+ *       { width: 500, height: 50, __convert: true },
  *       swatchesH(gradient, 5, 50)
  *     )
  *   )

package/mix.d.ts

@@ -55,6 +55,7 @@ export declare const mixNNNN: ColorMixFn;
  *
  * @example
  * ```ts
+ * import { mix, rgb, RED, GREEN } from "@thi.ng/color";
  * import { circular } from "@thi.ng/math";
  *
  * mix([], rgb("#f00"), rgb("#0f0"), 0.5);

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/color",
-  "version": "5.6.24",
+  "version": "5.6.25",
   "description": "Array-based color types, CSS parsing, conversions, transformations, declarative theme generation, gradients, presets",
   "type": "module",
   "module": "./index.js",
@@ -39,19 +39,19 @@
     "tool:swatches": "bun tools/index.ts"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.25",
-    "@thi.ng/arrays": "^2.8.2",
-    "@thi.ng/binary": "^3.4.14",
+    "@thi.ng/api": "^8.9.26",
+    "@thi.ng/arrays": "^2.8.3",
+    "@thi.ng/binary": "^3.4.15",
     "@thi.ng/checks": "^3.5.0",
-    "@thi.ng/compare": "^2.2.21",
-    "@thi.ng/compose": "^2.1.64",
-    "@thi.ng/defmulti": "^3.0.25",
+    "@thi.ng/compare": "^2.2.22",
+    "@thi.ng/compose": "^2.1.65",
+    "@thi.ng/defmulti": "^3.0.26",
     "@thi.ng/errors": "^2.4.18",
-    "@thi.ng/math": "^5.10.2",
-    "@thi.ng/random": "^3.6.32",
-    "@thi.ng/strings": "^3.7.16",
-    "@thi.ng/transducers": "^8.9.6",
-    "@thi.ng/vectors": "^7.10.11"
+    "@thi.ng/math": "^5.10.3",
+    "@thi.ng/random": "^3.6.33",
+    "@thi.ng/strings": "^3.7.17",
+    "@thi.ng/transducers": "^8.9.7",
+    "@thi.ng/vectors": "^7.10.12"
   },
   "devDependencies": {
     "@microsoft/api-extractor": "^7.40.1",
@@ -445,5 +445,5 @@
       "vectors"
     ]
   },
-  "gitHead": "b97641d1d722f79a70ea68243fa95e845dca7a43\n"
+  "gitHead": "6e20f80dd9df1c8055ffa3c1e4d6f7598add0c0b\n"
 }

package/sort.d.ts

@@ -29,30 +29,34 @@ export declare const sort: <T extends import("@thi.ng/vectors").ReadonlyVec>(col
  * memory.
  *
  * ```ts
+ * import { css, luminanceSrgb, sortMapped, srgb } from "@thi.ng/color";
+ *
  * // memory buffer of 4 sRGB colors
- * const buf = new Float32Array([0,1,0,1, 0,0.5,0,1, 0,0.25,0,1, 0,0.75,0,1]);
+ * const buf = new Float32Array([
+ *   0, 1, 0, 1, 0, 0.5, 0, 1, 0, 0.25, 0, 1, 0, 0.75, 0, 1,
+ * ]);
  *
  * // map buffer (creates 4 SRGB instances linked to the buffer)
  * const pix = srgb.mapBuffer(buf);
  *
  * // display original order
- * pix.map(css);
+ * console.log(pix.map((x) => css(x)));
  * // [ '#00ff00', '#008000', '#004000', '#00bf00' ]
  *
  * // sort colors (buffer!) by luminance
  * sortMapped(pix, luminanceSrgb);
  *
  * // new order
- * pix.map(css);
+ * console.log(pix.map((x) => css(x)));
  * // [ '#004000', '#008000', '#00bf00', '#00ff00' ]
  *
  * // buffer contents have been re-ordered
- * buf
+ * console.log(buf);
  * // Float32Array(16) [
- * //     0, 0.25, 0, 1,    0,
- * //   0.5,    0, 1, 0, 0.75,
- * //     0,    1, 0, 1,    0,
- * //     1
+ * //     0, 0.25, 0, 1,
+ * //     0, 0.5, 0, 1,
+ * //     0, 0.75, 0, 1,
+ * //     0, 1, 0, 1
  * // ]
  * ```
  *