Added docs

src/prisms.ts

@@ -1,6 +1,18 @@
 import { AbstractPrism, Prism } from "./types.ts";
 
+/**
+ * Static methods for prisms
+ *
+ */
 export class Prisms {
+
+  /**
+   * Construct a prism that unions a series of prisms.
+   *
+   * - view: returns the first non-null view of the prism series
+   * - set: sets the value of the first prism that has a non-null view
+   *
+   */
   static union<Whole, Part>(...prisms: Prism<Whole, Part>[]) {
     return new class extends AbstractPrism<Whole, Part> {
       view(whole: Whole): Part | null {

src/traversals.ts

@@ -1,6 +1,18 @@
 import { AbstractTraversal, Traversal } from "./types.ts";
 
+/**
+ * Static methods for traversals
+ *
+ */
 export class Traversals {
+
+  /**
+   * Construct a traversal that joins the views of multiple traversals.
+   *
+   * - view: returns the concatenation of the views of each traversal
+   * - modify: applies the modifier to the view of each traversal
+   *
+   */
   static union<Whole, Part>(...traversals: Traversal<Whole, Part>[]) {
     return new class extends AbstractTraversal<Whole, Part> {
       view(whole: Whole): Part[] {

src/types.ts

@@ -12,6 +12,10 @@ export interface Prism<Whole, Part> {
   ): Prism<Whole, SubPart>;
 }
 
+/*
+ * Partial implementation of the prism interface, leaving view and set abstract
+ *
+ */
 export abstract class AbstractPrism<Whole, Part> implements Prism<Whole, Part> {
   abstract view(whole: Whole): Part | null;
   abstract set(newPart: Part, whole: Whole): Whole;
@@ -78,6 +82,10 @@ export interface Traversal<Whole, Part> {
   composePrism<SubPart>(prism: Prism<Part, SubPart>): Traversal<Whole, SubPart>;
 }
 
+/*
+ * Partial implementation of the traversal interface, leaving view and modify abstract
+ *
+ */
 export abstract class AbstractTraversal<Whole, Part>
   implements Traversal<Whole, Part> {
   abstract view(whole: Whole): Part[];