docs: add svg size

Author: crimx

.export-size-svg.mjs

@@ -0,0 +1,46 @@
+import { defineConfig } from "export-size-svg";
+
+export default defineConfig({
+  title: "@embra/reactivity",
+  out: "./docs/assets",
+  exports: [
+    {
+      title: "*",
+      code: "export * from './src/index.ts'",
+    },
+    {
+      title: "{ readable, writable } (core)",
+      code: "export { readable, writable } from './src/index.ts'",
+    },
+    {
+      title: "{ watch }",
+      code: "export { watch } from './src/watch.ts'",
+      externals: ["./batch", "./utils"],
+    },
+    {
+      title: "{ compute }",
+      code: "export { compute } from './src/compute.ts'",
+      externals: ["./readable", "./utils"],
+    },
+    {
+      title: "{ combine }",
+      code: "export { combine } from './src/combine.ts'",
+      externals: ["./compute"],
+    },
+    {
+      title: "{ derive }",
+      code: "export { derive } from './src/derive.ts'",
+      externals: ["./compute"],
+    },
+    {
+      title: "{ reactiveMap }",
+      code: "export { reactiveMap } from './src/collections/reactiveMap.ts'",
+      externals: ["../batch", "../readable", "../utils"],
+    },
+    {
+      title: "{ reactiveSet }",
+      code: "export { reactiveSet } from './src/collections/reactiveSet.ts'",
+      externals: ["../batch", "../readable", "../utils"],
+    },
+  ],
+});

README.md

@@ -17,3 +17,5 @@ Chainable, hook-flavored signals.
 ```bash
 npm add @embra/reactivity
 ```
+
+![export size](https://embra.github.io/reactivity/assets/export-size.svg)

package-lock.json

@@ -21,7 +21,7 @@
     "lint": "eslint && prettier --check .",
     "lint:fix": "eslint --fix && prettier --write .",
     "ts-check": "tsc --noEmit",
-    "docs": "typedoc --options typedoc.json && prettier --ignore-path .prettierignore --write docs",
+    "docs": "typedoc --options typedoc.json && prettier --ignore-path .prettierignore --write docs && export-size-svg",
     "test": "vitest",
     "test:coverage": "vitest --coverage",
     "test:ci": "vitest --coverage",
@@ -46,6 +46,7 @@
     "@wopjs/gzip-size": "^0.1.2",
     "commit-and-tag-version": "^12.5.1",
     "eslint": "^9.31.0",
+    "export-size-svg": "^0.0.5",
     "jest-extended": "^6.0.0",
     "prettier": "^3.6.2",
     "tsup": "^8.5.0",

package.json

@@ -5,7 +5,6 @@ export interface Derive {
   /**
    * Derive a new Readable with same value from the given Readable.
    * @param dep$ - The Readable to derive from.
-   * @param config - Custom config for the derived Readable.
    * @returns A Readable with same value as the given Readable.
    */
   <TDepValue = any, TValue = any>(dep$: Readable<TDepValue>): OwnedReadable<TValue>;
@@ -18,7 +17,7 @@ export interface Derive {
    */
   <TDepValue = any, TValue = any>(
     dep$: Readable<TDepValue>,
-    transform: (depValue: TDepValue) => TValue,
+    transform?: (depValue: TDepValue) => TValue,
     config?: Config<TValue>,
   ): OwnedReadable<TValue>;
 }

src/derive.ts

@@ -1,14 +1,16 @@
 export type {
   Get,
   Readable,
-  Unwrap,
+  OwnedReadable,
   Writable,
+  OwnedWritable,
   Config,
   Disposer,
   Equal,
-  SetValue,
   Subscriber,
+  SetValue,
   Version,
+  Unwrap,
 } from "./typings";
 
 export { type Listener, type RemoveListener } from "./event";
@@ -17,12 +19,12 @@ export { batch, batchFlush, batchStart } from "./batch";
 
 export { compute, type ComputeFn } from "./compute";
 export { derive, type Derive } from "./derive";
-export { combine, type Combine } from "./combine";
+export { combine, type Combine, type MapReadablesToValues } from "./combine";
 
-export { readable, writable, toWritable } from "./readable";
+export { readable, type CreateReadable, writable, type CreateWritable, toWritable, type ToWritable } from "./readable";
 export { watch, type WatchEffect } from "./watch";
 
-export { isReadable, unsubscribe, strictEqual, arrayShallowEqual } from "./utils";
+export { isReadable, type IsReadable, unsubscribe, strictEqual, arrayShallowEqual } from "./utils";
 
 export {
   reactiveMap,

src/index.ts

@@ -23,7 +23,7 @@ const registry = /* @__PURE__ */ new FinalizationRegistry<{
   }
 });
 
-interface CreateReadable {
+export interface CreateReadable {
   /**
    * Creates a Readonly with the given value.
    *
@@ -61,6 +61,9 @@ interface CreateReadable {
 
 /** @internal */
 export class ReadableImpl<TValue = any> implements BatchTask {
+  /**
+   * @internal
+   */
   public readonly [BRAND]: BRAND = BRAND;
 
   /**
@@ -358,7 +361,7 @@ export const toWritable: ToWritable = <TValue>(
   set: (this: void, value: TValue) => void,
 ): OwnedWritable<TValue> => ((($ as OwnedWritable<TValue>).set = set), $ as OwnedWritable<TValue>);
 
-interface CreateWritable {
+export interface CreateWritable {
   /**
    * Creates a Writable.
    * @returns A Writable with undefined value.

src/readable.ts

@@ -35,6 +35,9 @@ export interface Readable<TValue = any> {
    * If two versions of a $ is not equal(`Object.is`), it means the `value` has changed (event if the `value` is equal).
    */
   readonly $version: Version;
+  /**
+   * @internal
+   */
   readonly [BRAND]: BRAND;
   /**
    * Current value of the $.

src/typings.ts

@@ -61,7 +61,7 @@ export const arrayShallowEqual = (arrA: any, arrB: any): boolean => {
   return true;
 };
 
-interface IsReadable {
+export interface IsReadable {
   <T extends Readable>($: T): $ is T;
   ($: unknown): $ is Readable;
   ($: any): $ is Readable;