Skip to content

Commit 57bc903

Browse files
authored
Remove internal annotation to avoid confusing TS (#747)
1 parent 90d3020 commit 57bc903

File tree

2 files changed

+11
-2
lines changed

2 files changed

+11
-2
lines changed

.changeset/tricky-pots-confess.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
"@preact/signals-core": patch
3+
---
4+
5+
Remove internal annotation as it confused TS

packages/core/src/index.ts

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -544,7 +544,9 @@ function cleanupSources(target: Computed | Effect) {
544544
target._sources = head;
545545
}
546546

547-
/** @internal */
547+
/**
548+
* The base class for computed signals.
549+
*/
548550
declare class Computed<T = any> extends Signal<T> {
549551
_fn: () => T;
550552
_sources?: Node;
@@ -780,7 +782,9 @@ type EffectFn =
780782
| ((this: { dispose: () => void }) => void | (() => void))
781783
| (() => void | (() => void));
782784

783-
/** @internal */
785+
/**
786+
* The base class for reactive effects.
787+
*/
784788
declare class Effect {
785789
_fn?: EffectFn;
786790
_cleanup?: () => void;

0 commit comments

Comments
 (0)