Skip to content

Commit

Permalink
fix ci
Browse files Browse the repository at this point in the history
  • Loading branch information
XantreDev committed Aug 2, 2023
1 parent 4b713b3 commit 460100f
Show file tree
Hide file tree
Showing 6 changed files with 22 additions and 25 deletions.
5 changes: 5 additions & 0 deletions .changeset/empty-spiders-wave.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
"@preact-signals/unified-signals": patch
---

Added readme
1 change: 0 additions & 1 deletion .changeset/thirty-grapes-relate.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,5 @@
---
"@preact-signals/unified-signals": patch
"@preact-signals/polyfills": patch
"@preact-signals/query": patch
"@preact-signals/utils": patch
---
Expand Down
18 changes: 16 additions & 2 deletions packages/unified-signals/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# `@preact-signals/unified-signals`

`@preact-signals/unified-signals` is runtime agnostic `@preact/signals` reexport which imports should be remaped depending on the runtime.
`@preact-signals/unified-signals` is runtime agnostic `@preact/signals` reexport. That can be used for library developers that want to rely on user preact signals runtime. If you want to write library that uses preact signals you can take benefit from `@preact-signals/unified-signals`. It uses shims instead of hooks if runtime is not providing it, also we polyfilling `untracked` API.

## Installation

Expand All @@ -17,7 +17,21 @@ pnpm i @preact-signals/unified-signals

## API Overview

Same api that `@preact/signals` provides.
Basic `@preact/signals` API and untracked

### `untracked`

```ts
const a = signal(1);
const b = signal(2);
const c = computed(() => a.value + untracked(() => b.value));

console.log(c.value); // 3
a.value = 2;
console.log(c.value); // 4
b.value = 3;
console.log(c.value); // 4
```

## License

Expand Down
1 change: 0 additions & 1 deletion packages/utils/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,6 @@
}
},
"dependencies": {
"@preact-signals/polyfills": "workspace:*",
"@preact-signals/unified-signals": "workspace:*",
"react-fast-hoc": "^0.1"
},
Expand Down
19 changes: 0 additions & 19 deletions pnpm-lock.yaml

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions tsconfig.json
Original file line number Diff line number Diff line change
Expand Up @@ -25,8 +25,7 @@
"@preact-signals/utils/*": ["./packages/utils/src/*"],
"@preact-signals/unified-signals": [
"./packages/unified-signals/src/index.d.ts"
],
"@preact-signals/polyfills": ["./packages/polyfills/src"]
]
}
},
"exclude": [
Expand Down

0 comments on commit 460100f

Please sign in to comment.