add better docs from wiggle options

Author: g-harel

README.md

@@ -234,9 +234,16 @@ export interface TimestampProvider {
 export const canvasPath: (timestampProvider?: TimestampProvider) => Animation;
 
 export interface WiggleOptions {
+    // Speed of the wiggle movement. Higher is faster.
     speed: number;
+    // Delay before the first wiggle frame.
+    // Default: 0
     initialDelay?: number;
+    // Length of the transition from the current state to the wiggle blob.
+    // Default: 0
     initialTransition?: number;
+    // Interpolation function.
+    // Default: linear
     initialTimingFunction?: Keyframe["timingFunction"];
 }
 // Preset animation that produces natural-looking random movement.

public/animate.ts

@@ -78,9 +78,16 @@ export interface TimestampProvider {
 }
 
 export interface WiggleOptions {
+    // Speed of the wiggle movement. Higher is faster.
     speed: number;
+    // Delay before the first wiggle frame.
+    // Default: 0
     initialDelay?: number;
+    // Length of the transition from the current state to the wiggle blob.
+    // Default: 0
     initialTransition?: number;
+    // Interpolation function.
+    // Default: linear
     initialTimingFunction?: Keyframe["timingFunction"];
 }
 

public/blobs.ts

@@ -5,21 +5,27 @@ import {mapPoints} from "../internal/util";
 import {checkBlobOptions, checkCanvasOptions, checkSvgOptions} from "../internal/check";
 
 export interface BlobOptions {
+    // A given seed will always produce the same blob.
+    // Use `Math.random()` for pseudorandom behavior.
     seed: string | number;
+    // Actual number of points will be `3 + extraPoints`.
     extraPoints: number;
+    // Increases the amount of variation in point position.
     randomness: number;
+    // Size of the bounding box.
     size: number;
 }
 
 export interface CanvasOptions {
+    // Coordinates of top-left corner of the blob.
     offsetX?: number;
     offsetY?: number;
 }
 
 export interface SvgOptions {
-    fill?: string;
-    stroke?: string;
-    strokeWidth?: number;
+    fill?: string; // Default: "#ec576b".
+    stroke?: string; // Default: "none".
+    strokeWidth?: number; // Default: 0.
 }
 
 export const canvasPath = (blobOptions: BlobOptions, canvasOptions: CanvasOptions = {}): Path2D => {