fix: improve exposed API (#19)

.changeset/pink-vans-exercise.md

@@ -0,0 +1,5 @@
+---
+"windpipe": patch
+---
+
+Improve exported API and generated docs

package.json

@@ -7,7 +7,7 @@
     "lint": "tsc && eslint .",
     "format": "eslint --fix .",
     "build": "tsup ./src/index.ts",
-    "doc": "typedoc ./src --media ./media --plugin typedoc-plugin-extras --favicon ./media/favicon.ico --footerLastModified true --plugin typedoc-material-theme --themeColor '#03284e'",
+    "doc": "typedoc ./src --media ./media --plugin typedoc-plugin-extras --favicon ./media/favicon.ico --footerLastModified true --plugin typedoc-material-theme --themeColor '#03284e' --plugin typedoc-plugin-rename-defaults",
     "test": "vitest",
     "ci:release": "npm run build && changeset publish"
   },
@@ -56,6 +56,7 @@
     "typedoc": "^0.25.7",
     "typedoc-material-theme": "^1.0.2",
     "typedoc-plugin-extras": "^3.0.0",
+    "typedoc-plugin-rename-defaults": "^0.7.0",
     "typescript": "^5.3.3",
     "typescript-eslint": "^7.6.0",
     "vitest": "^1.2.0"

src/index.ts

@@ -1,10 +1,19 @@
 import { Stream } from "./stream";
 
 // Export all useful types for atoms
-export type { Atom, AtomOk, AtomError, AtomUnknown } from "./atom";
+export type {
+    Atom,
+    AtomOk,
+    AtomError,
+    AtomUnknown,
+    VALUE,
+    ERROR,
+    UNKNOWN,
+    MaybeAtom,
+} from "./atom";
 
-// Re-export all utility types
-export type * from "./util";
+// Re-export useful utility types
+export type { MaybePromise, Truthy, CallbackOrStream } from "./util";
 
 // Export the `StreamEnd` type
 export type { StreamEnd } from "./stream";

src/stream/index.ts

@@ -14,6 +14,10 @@ import { HigherOrderStream } from "./higher-order";
 
 export type { StreamEnd } from "./base";
 
+/**
+ * @template T - Type of the 'values' on the stream.
+ * @template E - Type of the 'errors' on the stream.
+ */
 export class Stream<T, E> extends HigherOrderStream<T, E> {
     // Re-export atom utilities for convenience
     /**