@kurkle/color 0.3.4 → 0.5.0

package/README.md

@@ -66,9 +66,21 @@ hsv(244, 100%, 100%, 0.6)
 
 **note** The docs are for the ESM module. UMD module only exports the [default export](https://kurkle.github.io/color/modules.html#default)
 
+### Documentation Generation
+
+The documentation is automatically generated using TypeDoc and deployed to GitHub Pages whenever changes are pushed to the main branch.
+
+To generate documentation locally:
+
+```bash
+npm run docs
+```
+
+This will create documentation in the `docs` directory, which you can preview locally before pushing changes.
+
 ## Benchmarks
 
-[benchmarks](https://kurkle.github.io/color/dev/bench/)
+[benchmarks](https://kurkle.github.io/color/dev/bench/) — see [bench/README.md](bench/README.md) for how to run them locally.
 
 ## Size visualization
 

package/dist/byte.d.ts

@@ -0,0 +1,35 @@
+/**
+ * @packageDocumentation
+ * @module utils
+ */
+/**
+ * Rounds decimal to nearest integer
+ * @param v - the number to round
+ */
+export declare function round(v: number): number;
+export declare const lim: (v: number, l: number, h: number) => number;
+/**
+ * convert percent to byte 0..255
+ * @param v - 0..100
+ */
+export declare function p2b(v: number): number;
+/**
+ * convert byte to percet 0..100
+ * @param v - 0..255
+ */
+export declare function b2p(v: number): number;
+/**
+ * convert normalized to byte 0..255
+ * @param v - 0..1
+ */
+export declare function n2b(v: number): number;
+/**
+ * convert byte to normalized 0..1
+ * @param v - 0..255
+ */
+export declare function b2n(v: number): number;
+/**
+ * convert normalized to percent 0..100
+ * @param v - 0..1
+ */
+export declare function n2p(v: number): number;