✨ initial implementation

Author: astoilkov

index.ts

@@ -0,0 +1,2 @@
+export { default as createDeepMemo } from "./src/createDeepMemo";
+export { default as createDeepSignal } from "./src/createDeepSignal";

package.json

@@ -1,17 +1,25 @@
 {
-    "name": "{{data.name}}",
+    "name": "create-deep",
     "version": "0.1.0",
-    "description": "{{data.description}}",
+    "description": "Mimics SolidJS's `createSignal()` and `createMemo()` but with deep equality checks",
     "license": "MIT",
-    "repository": "astoilkov/{{data.name}}",
+    "repository": "astoilkov/create-deep",
     "funding": "https://github.com/sponsors/astoilkov",
     "author": {
         "name": "Antonio Stoilkov",
         "email": "hello@astoilkov.com",
         "url": "https://astoilkov.com"
     },
     "keywords": [
-        "{{data.keywords}}"
+        "SolidJS",
+        "memo",
+        "signal",
+        "createMemo",
+        "createSignal",
+        "createDeepMemo",
+        "createDeepSignal",
+        "deep equality",
+        "reactivity"
     ],
     "type": "module",
     "exports": {
@@ -33,11 +41,18 @@
         "src/*.js",
         "src/*.d.ts"
     ],
+    "dependencies": {
+        "dequal": "^2.0.3"
+    },
+    "peerDependencies": {
+        "solid-js": ">=1.5"
+    },
     "devDependencies": {
         "@vitest/coverage-v8": "^0.33.0",
         "jsdom": "^22.1.0",
         "np": "^8.0.4",
         "prettier": "^3.0.3",
+        "solid-js": "^1.8.6",
         "typescript": "^5.2.2",
         "vitest": "^0.34.6"
     }

readme.md

@@ -1,22 +1,36 @@
-# `{{data.name}}`
+# `create-deep`
 
-> {{data.description}}
+> Mimics SolidJS's `createSignal()` and `createMemo()` but with deep equality checks.
 
-[![Gzipped Size](https://img.shields.io/bundlephobia/minzip/{{data.name}})](https://bundlephobia.com/result?p={{data.name}})
-[![Build Status](https://img.shields.io/github/actions/workflow/status/astoilkov/{{data.name}}/main.yml?branch=main)](https://github.com/astoilkov/{{data.name}}/actions/workflows/main.yml)
+[![Gzipped Size](https://img.shields.io/bundlephobia/minzip/create-deep)](https://bundlephobia.com/result?p=create-deep)
+[![Build Status](https://img.shields.io/github/actions/workflow/status/astoilkov/create-deep/main.yml?branch=main)](https://github.com/astoilkov/create-deep/actions/workflows/main.yml)
 
 ## Install
 
 ```bash
-npm install {{data.name}}
+npm install create-deep
 ```
 
-## Why
+## API
 
-## Usage
+[`dequal`](https://github.com/lukeed/dequal) is used for the deep equality checks.
 
-## API
+#### `createDeepSignal<T>(value?: T)`
+
+```ts
+function Component() {
+    const [value, setValue] = createDeepSignal([1, 2, 3])
+}
+```
+
+#### `createDeepMemo<T>(() => T)`
+
+```ts
+function Component() {
+    const value = createDeepMemo(() => {
+        return items().filter(item => item.size > 0)
+    })
+}
+```
 
-## Alternatives
 
-## Related

src/createDeepMemo.ts

@@ -0,0 +1,35 @@
+import { dequal } from "dequal";
+import {
+    Accessor,
+    createMemo,
+    EffectFunction,
+    MemoOptions,
+    NoInfer,
+} from "solid-js";
+
+export default function createDeepMemo<Next extends Prev, Prev = Next>(
+    fn: EffectFunction<undefined | NoInfer<Prev>, Next>,
+): Accessor<Next>;
+export default function createDeepMemo<
+    Next extends Prev,
+    Init = Next,
+    Prev = Next,
+>(
+    fn: EffectFunction<Init | Prev, Next>,
+    value: Init,
+    options?: MemoOptions<Next>,
+): Accessor<Next>;
+export default function createDeepMemo<
+    Next extends Prev,
+    Init = Next,
+    Prev = Next,
+>(
+    fn: EffectFunction<undefined | NoInfer<Prev> | Init | Prev, Next>,
+    value?: Init,
+    options?: MemoOptions<Next>,
+): Accessor<Next> {
+    return createMemo(fn, value, {
+        equals: dequal,
+        ...options,
+    });
+}

src/createDeepSignal.ts

@@ -0,0 +1,17 @@
+import { dequal } from "dequal";
+import { createSignal, Signal, SignalOptions } from "solid-js";
+
+export default function createDeepSignal<T>(): Signal<T | undefined>;
+export default function createDeepSignal<T>(
+    value: T,
+    options?: SignalOptions<T>,
+): Signal<T>;
+export default function createDeepSignal<T>(
+    value?: T,
+    options?: SignalOptions<T | undefined>,
+): Signal<T | undefined> {
+    return createSignal(value, {
+        equals: dequal,
+        ...options,
+    });
+}

test.ts

@@ -1,7 +1,14 @@
-import { describe, expect, test } from "vitest";
+import { describe, test } from "vitest";
+import createDeepMemo from "./src/createDeepMemo";
+import createDeepSignal from "./src/createDeepSignal";
 
-describe("{{data.name}}", () => {
-    test("", () => {
-        expect(true).toBe(true);
+// for some reason, Solid reactivity doesn't work in tests
+describe("create-deep", () => {
+    test("createDeepSignal()", () => {
+        createDeepSignal(() => [1, 2, 3]);
+    });
+
+    test("createDeepMemo()", () => {
+        createDeepMemo(() => [1, 2, 3]);
     });
 });