Skip to content

Commit 4cffed7

Browse files
committed
chore: update api files
1 parent 8d5a708 commit 4cffed7

File tree

3 files changed

+28
-28
lines changed

3 files changed

+28
-28
lines changed

packages/docs/src/routes/api/qwik/api.json

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -335,7 +335,7 @@
335335
],
336336
"kind": "Interface",
337337
"content": "A computed signal is a signal which is calculated from other signals. When the signals change, the computed signal is recalculated, and if the result changed, all tasks which are tracking the signal will be re-run and all components that read the signal will be re-rendered.\n\n\n```typescript\nexport interface ComputedSignal<T> extends ReadonlySignal<T> \n```\n**Extends:** [ReadonlySignal](#readonlysignal)<!-- -->&lt;T&gt;\n\n\n<table><thead><tr><th>\n\nMethod\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[force()](#computedsignal-force)\n\n\n</td><td>\n\nUse this to force recalculation and running subscribers, for example when the calculated value mutates but remains the same object. Useful for third-party libraries.\n\n\n</td></tr>\n</tbody></table>",
338-
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
338+
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
339339
"mdFile": "core.computedsignal.md"
340340
},
341341
{
@@ -391,7 +391,7 @@
391391
],
392392
"kind": "Function",
393393
"content": "Create a computed signal which is calculated from the given QRL. A computed signal is a signal which is calculated from other signals. When the signals change, the computed signal is recalculated.\n\nThe QRL must be a function which returns the value of the signal. The function must not have side effects, and it must be synchronous.\n\nIf you need the function to be async, use `useSignal` and `useTask$` instead.\n\n\n```typescript\ncreateComputed$: <T>(qrl: () => T) => T extends Promise<any> ? never : ComputedSignal<T>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nqrl\n\n\n</td><td>\n\n() =&gt; T\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nT extends Promise&lt;any&gt; ? never : [ComputedSignal](#computedsignal)<!-- -->&lt;T&gt;",
394-
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
394+
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
395395
"mdFile": "core.createcomputed_.md"
396396
},
397397
{
@@ -419,7 +419,7 @@
419419
],
420420
"kind": "Function",
421421
"content": "Create a signal that holds a custom serializable value. See [useSerializer$](#useserializer_) for more details.\n\n\n```typescript\ncreateSerializer$: <T, S>(arg: SerializerArg<T, S>) => T extends Promise<any> ? never : SerializerSignal<T>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\narg\n\n\n</td><td>\n\nSerializerArg&lt;T, S&gt;\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nT extends Promise&lt;any&gt; ? never : SerializerSignal&lt;T&gt;",
422-
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
422+
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
423423
"mdFile": "core.createserializer_.md"
424424
},
425425
{
@@ -433,7 +433,7 @@
433433
],
434434
"kind": "Variable",
435435
"content": "Creates a Signal with the given value. If no value is given, the signal is created with `undefined`<!-- -->.\n\n\n```typescript\ncreateSignal: {\n <T>(): Signal<T | undefined>;\n <T>(value: T): Signal<T>;\n}\n```",
436-
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
436+
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
437437
"mdFile": "core.createsignal.md"
438438
},
439439
{
@@ -731,7 +731,7 @@
731731
],
732732
"kind": "Function",
733733
"content": "```typescript\nisSignal: (value: any) => value is Signal<unknown>\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nvalue\n\n\n</td><td>\n\nany\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nvalue is [Signal](#signal)<!-- -->&lt;unknown&gt;",
734-
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.ts",
734+
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/utils.ts",
735735
"mdFile": "core.issignal.md"
736736
},
737737
{
@@ -1543,7 +1543,7 @@
15431543
],
15441544
"kind": "Interface",
15451545
"content": "```typescript\nexport interface ReadonlySignal<T = unknown> \n```\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[value](#)\n\n\n</td><td>\n\n`readonly`\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
1546-
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
1546+
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
15471547
"mdFile": "core.readonlysignal.md"
15481548
},
15491549
{
@@ -1781,7 +1781,7 @@
17811781
],
17821782
"kind": "Interface",
17831783
"content": "A signal is a reactive value which can be read and written. When the signal is written, all tasks which are tracking the signal will be re-run and all components that read the signal will be re-rendered.\n\nFurthermore, when a signal value is passed as a prop to a component, the optimizer will automatically forward the signal. This means that `return <div title={signal.value}>hi</div>` will update the `title` attribute when the signal changes without having to re-render the component.\n\n\n```typescript\nexport interface Signal<T = any> extends ReadonlySignal<T> \n```\n**Extends:** [ReadonlySignal](#readonlysignal)<!-- -->&lt;T&gt;\n\n\n<table><thead><tr><th>\n\nProperty\n\n\n</th><th>\n\nModifiers\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\n[value](#)\n\n\n</td><td>\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>",
1784-
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts",
1784+
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts",
17851785
"mdFile": "core.signal.md"
17861786
},
17871787
{
@@ -2089,7 +2089,7 @@
20892089
],
20902090
"kind": "Function",
20912091
"content": "Get the original object that was wrapped by the store. Useful if you want to clone a store (structuredClone, IndexedDB,...)\n\n\n```typescript\nunwrapStore: <T>(value: T) => T\n```\n\n\n<table><thead><tr><th>\n\nParameter\n\n\n</th><th>\n\nType\n\n\n</th><th>\n\nDescription\n\n\n</th></tr></thead>\n<tbody><tr><td>\n\nvalue\n\n\n</td><td>\n\nT\n\n\n</td><td>\n\n\n</td></tr>\n</tbody></table>\n**Returns:**\n\nT",
2092-
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/store.ts",
2092+
"editUrl": "https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/impl/store.ts",
20932093
"mdFile": "core.unwrapstore.md"
20942094
},
20952095
{

packages/docs/src/routes/api/qwik/index.md

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -383,7 +383,7 @@ Use this to force recalculation and running subscribers, for example when the ca
383383
</td></tr>
384384
</tbody></table>
385385
386-
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
386+
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
387387
388388
## ContextId
389389
@@ -706,7 +706,7 @@ qrl
706706
707707
T extends Promise&lt;any&gt; ? never : [ComputedSignal](#computedsignal)&lt;T&gt;
708708
709-
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
709+
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
710710
711711
## createContextId
712712
@@ -826,7 +826,7 @@ SerializerArg&lt;T, S&gt;
826826

827827
T extends Promise&lt;any&gt; ? never : SerializerSignal&lt;T&gt;
828828

829-
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
829+
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
830830

831831
## createSignal
832832

@@ -839,7 +839,7 @@ createSignal: {
839839
}
840840
```
841841
842-
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
842+
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
843843
844844
## CSSProperties
845845
@@ -1456,7 +1456,7 @@ any
14561456
14571457
value is [Signal](#signal)&lt;unknown&gt;
14581458
1459-
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.ts)
1459+
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/utils.ts)
14601460
14611461
## jsx
14621462
@@ -2906,7 +2906,7 @@ T
29062906
</td></tr>
29072907
</tbody></table>
29082908
2909-
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
2909+
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
29102910
29112911
## render
29122912
@@ -3761,7 +3761,7 @@ T
37613761
</td></tr>
37623762
</tbody></table>
37633763
3764-
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/signal.public.ts)
3764+
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/signal.public.ts)
37653765
37663766
## SkipRender
37673767
@@ -8415,7 +8415,7 @@ T
84158415
84168416
T
84178417
8418-
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/signal/store.ts)
8418+
[Edit this section](https://github.com/QwikDev/qwik/tree/main/packages/qwik/src/core/reactive-primitives/impl/store.ts)
84198419
84208420
## useComputed$
84218421

packages/qwik/src/core/core.api.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -238,15 +238,6 @@ export { DomContainer as _DomContainer }
238238
// @internal (undocumented)
239239
export const _EFFECT_BACK_REF: unique symbol;
240240

241-
// @internal (undocumented)
242-
export class _EffectData {
243-
constructor(data: NodePropData);
244-
// Warning: (ae-forgotten-export) The symbol "NodePropData" needs to be exported by the entry point index.d.ts
245-
//
246-
// (undocumented)
247-
data: NodePropData;
248-
}
249-
250241
// @internal (undocumented)
251242
export type _ElementVNode = [
252243
_VNodeFlags.Element,
@@ -290,10 +281,10 @@ export type EventHandler<EV = Event, EL = Element> = {
290281
// @internal (undocumented)
291282
export const eventQrl: <T>(qrl: QRL<T>) => QRL<T>;
292283

293-
// Warning: (ae-forgotten-export) The symbol "WrappedSignal" needs to be exported by the entry point index.d.ts
284+
// Warning: (ae-forgotten-export) The symbol "WrappedSignalImpl" needs to be exported by the entry point index.d.ts
294285
//
295286
// @internal (undocumented)
296-
export const _fnSignal: <T extends (...args: any) => any>(fn: T, args: Parameters<T>, fnStr?: string) => WrappedSignal<any>;
287+
export const _fnSignal: <T extends (...args: any) => any>(fn: T, args: Parameters<T>, fnStr?: string) => WrappedSignalImpl<any>;
297288

298289
// @public (undocumented)
299290
export const Fragment: FunctionComponent<{
@@ -894,7 +885,7 @@ export abstract class _SharedContainer implements Container {
894885
// (undocumented)
895886
abstract setHostProp<T>(host: HostElement, name: string, value: T): void;
896887
// (undocumented)
897-
trackSignalValue<T>(signal: Signal, subscriber: HostElement, property: string, data: _EffectData): T;
888+
trackSignalValue<T>(signal: Signal, subscriber: HostElement, property: string, data: _SubscriptionData): T;
898889
}
899890

900891
// @public
@@ -1011,6 +1002,15 @@ export interface StreamWriter {
10111002
// @internal (undocumented)
10121003
export type _Stringifiable = string | boolean | number | null;
10131004

1005+
// @internal (undocumented)
1006+
export class _SubscriptionData {
1007+
constructor(data: NodePropData);
1008+
// Warning: (ae-forgotten-export) The symbol "NodePropData" needs to be exported by the entry point index.d.ts
1009+
//
1010+
// (undocumented)
1011+
data: NodePropData;
1012+
}
1013+
10141014
// Warning: (ae-forgotten-export) The symbol "AriaAttributes" needs to be exported by the entry point index.d.ts
10151015
//
10161016
// @public

0 commit comments

Comments
 (0)