@thi.ng/axidraw 1.1.58 → 1.1.60

package/CHANGELOG.md

@@ -1,6 +1,6 @@
 # Change Log
 
-- **Last updated**: 2024-02-22T11:59:16Z
+- **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.
@@ -9,6 +9,12 @@ See [Conventional Commits](https://conventionalcommits.org/) for commit guidelin
 **Note:** Unlisted _patch_ versions only involve non-code or otherwise excluded changes
 and/or version bumps of transitive dependencies.
 
+### [1.1.59](https://github.com/thi-ng/umbrella/tree/@thi.ng/axidraw@1.1.59) (2024-02-22)
+
+#### ♻️ Refactoring
+
+- update object destructuring in all pkgs & examples ([f36aeb0](https://github.com/thi-ng/umbrella/commit/f36aeb0))
+
 ## [1.1.0](https://github.com/thi-ng/umbrella/tree/@thi.ng/axidraw@1.1.0) (2023-03-22)
 
 #### 🚀 Features

package/axidraw.d.ts

@@ -49,13 +49,19 @@ export declare class AxiDraw implements IReset {
      * Reference:
      * - http://evil-mad.github.io/EggBot/ebb.html
      *
+     * Also see {@link complete}.
+     *
      * @example
      * ```ts
+     * import { AxiDraw, polyline, START, STOP } from "@thi.ng/axidraw";
+     *
+     * const axi = new AxiDraw();
+     *
      * // execute start sequence, draw a triangle, then exec stop sequence
      * axi.draw([
-     *   ["start"],
-     *   ...axi.polyline([[50,50], [100,50], [75, 100], [50,50]]),
-     *   ["stop"]
+     *   START,
+     *   ...polyline([[50, 50], [100, 50], [75, 100], [50, 50]]),
+     *   STOP
      * ]);
      * ```
      *

package/axidraw.js

@@ -132,13 +132,19 @@ class AxiDraw {
    * Reference:
    * - http://evil-mad.github.io/EggBot/ebb.html
    *
+   * Also see {@link complete}.
+   *
    * @example
    * ```ts
+   * import { AxiDraw, polyline, START, STOP } from "@thi.ng/axidraw";
+   *
+   * const axi = new AxiDraw();
+   *
    * // execute start sequence, draw a triangle, then exec stop sequence
    * axi.draw([
-   *   ["start"],
-   *   ...axi.polyline([[50,50], [100,50], [75, 100], [50,50]]),
-   *   ["stop"]
+   *   START,
+   *   ...polyline([[50, 50], [100, 50], [75, 100], [50, 50]]),
+   *   STOP
    * ]);
    * ```
    *

package/commands.d.ts

@@ -63,6 +63,8 @@ export declare const COMMENT: (msg: string) => CommentCommand;
  *
  * @example
  * ```ts
+ * import { complete, MOVE } from "@thi.ng/axidraw";
+ *
  * [...complete([ MOVE([0, 0]) ])]
  * // [ ["start"], ["M", [0, 0]], ["stop"] ]
  * ```

package/dip.d.ts

@@ -35,8 +35,10 @@ export interface DipOpts {
  *
  * @example
  * ```ts
+ * import { dip, MOVE } from "@thi.ng/axidraw";
+ *
  * // simple 2x up/down
- * [...DIP(2)]
+ * [...dip(2)]
  * // [
  * //   [ "d", undefined ],
  * //   [ "u", undefined ],
@@ -45,7 +47,7 @@ export interface DipOpts {
  * // ]
  *
  * // 3x dipping with custom up/down delays, each time at a random position
- * [...DIP(3, {
+ * [...dip(3, {
  *   down: 300,
  *   up: 400,
  *   commands: () => [ MOVE([Math.random()* 5, Math.random()* 5]) ]

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@thi.ng/axidraw",
-  "version": "1.1.58",
+  "version": "1.1.60",
   "description": "Minimal AxiDraw plotter/drawing machine controller for Node.js",
   "type": "module",
   "module": "./index.js",
@@ -35,16 +35,16 @@
     "test": "bun test"
   },
   "dependencies": {
-    "@thi.ng/api": "^8.9.25",
+    "@thi.ng/api": "^8.9.26",
     "@thi.ng/checks": "^3.5.0",
-    "@thi.ng/compose": "^2.1.64",
-    "@thi.ng/date": "^2.6.0",
+    "@thi.ng/compose": "^2.1.65",
+    "@thi.ng/date": "^2.7.1",
     "@thi.ng/errors": "^2.4.18",
-    "@thi.ng/logger": "^3.0.2",
-    "@thi.ng/math": "^5.10.2",
-    "@thi.ng/transducers": "^8.9.5",
-    "@thi.ng/units": "^0.4.32",
-    "@thi.ng/vectors": "^7.10.10",
+    "@thi.ng/logger": "^3.0.3",
+    "@thi.ng/math": "^5.10.3",
+    "@thi.ng/transducers": "^8.9.7",
+    "@thi.ng/units": "^0.4.33",
+    "@thi.ng/vectors": "^7.10.12",
     "serialport": "^12.0.0"
   },
   "devDependencies": {
@@ -115,5 +115,5 @@
     "status": "alpha",
     "year": 2022
   },
-  "gitHead": "4513a1c703bdbf0f0867f03e547e47692e415fac\n"
+  "gitHead": "6e20f80dd9df1c8055ffa3c1e4d6f7598add0c0b\n"
 }

package/palettes.d.ts

@@ -70,6 +70,7 @@ export interface RadialPaletteOpts extends BasePaletteOpts {
  *
  * @example
  * ```ts
+ * import { AxiDraw, linearPalette } from "@thi.ng/axidraw";
  * import { points } from "@thi.ng/geom";
  * import { asAxiDraw } from "@thi.ng/geom-axidraw";
  * import { repeatedly } from "@thi.ng/transducers";

package/polyline.d.ts

@@ -12,5 +12,5 @@ import type { DrawCommand, PolylineOpts } from "./api.js";
  * @param pts
  * @param opts
  */
-export declare function polyline(pts: ReadonlyVec[], opts: Partial<PolylineOpts>): IterableIterator<DrawCommand>;
+export declare function polyline(pts: ReadonlyVec[], opts?: Partial<PolylineOpts>): IterableIterator<DrawCommand>;
 //# sourceMappingURL=polyline.d.ts.map

package/polyline.js

@@ -1,12 +1,8 @@
 import { DOWN, MOVE, PEN, UP } from "./commands.js";
-function* polyline(pts, opts) {
+function* polyline(pts, opts = {}) {
   if (!pts.length)
     return;
-  const { speed, delayDown, delayUp, down, onlyGeo } = {
-    speed: 1,
-    onlyGeo: false,
-    ...opts
-  };
+  const { speed = 1, onlyGeo = false, delayDown, delayUp, down } = opts;
   if (onlyGeo) {
     for (let p of pts)
       yield MOVE(p, speed);

package/registration.d.ts

@@ -6,7 +6,12 @@ import type { DrawCommand } from "./api.js";
  *
  * @example
  * ```ts
- * axi.draw(registrationMark([20, 20]))
+ * import { AxiDraw, registrationMark } from "@thi.ng/axidraw";
+ *
+ * const axi = new AxiDraw();
+ *
+ * // draw registration mark @ 20,20 with radius 10
+ * axi.draw(registrationMark([20, 20], 10))
  * ```
  *
  * @param pos