Skip to content

Commit 8f666d8

Browse files
wmertensclaude
andcommitted
chore: update api docs and docs-size baselines
Regenerated `qwik.core.api.md` for the `_injectAsyncSignalValue` / `_AsyncSignalImpl` internal exports added earlier, and refreshed the docs-size benchmark baselines after the router changes from the last few commits. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
1 parent 016112d commit 8f666d8

2 files changed

Lines changed: 175 additions & 35 deletions

File tree

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

Lines changed: 170 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,76 @@ export interface AsyncSignal<T = unknown> extends ComputedSignal<T> {
3131
promise(): Promise<void>;
3232
}
3333

34+
// Warning: (ae-forgotten-export) The symbol "ComputedSignalImpl" needs to be exported by the entry point index.d.ts
35+
// Warning: (ae-forgotten-export) The symbol "AsyncQRL" needs to be exported by the entry point index.d.ts
36+
// Warning: (ae-forgotten-export) The symbol "BackRef" needs to be exported by the entry point index.d.ts
37+
//
38+
// @internal
39+
export class _AsyncSignalImpl<T> extends ComputedSignalImpl<T, AsyncQRL<T>> implements BackRef, AsyncSignal<T> {
40+
// (undocumented)
41+
$computationTimeoutId$: ReturnType<typeof setTimeout> | undefined;
42+
$computeIfNeeded$(): void;
43+
// (undocumented)
44+
$concurrency$: number;
45+
// Warning: (ae-forgotten-export) The symbol "AsyncJob" needs to be exported by the entry point index.d.ts
46+
//
47+
// (undocumented)
48+
$current$: AsyncJob<T> | null;
49+
$destroy$(): Promise<void>;
50+
// (undocumented)
51+
$errorEffects$: undefined | Set<EffectSubscription>;
52+
// (undocumented)
53+
$info$: unknown;
54+
// (undocumented)
55+
$infoVersion$: number;
56+
// (undocumented)
57+
$interval$: number;
58+
// (undocumented)
59+
$jobs$: AsyncJob<T>[];
60+
// Warning: (ae-forgotten-export) The symbol "EffectSubscription" needs to be exported by the entry point index.d.ts
61+
//
62+
// (undocumented)
63+
$loadingEffects$: undefined | Set<EffectSubscription>;
64+
// (undocumented)
65+
$pollTimeoutId$: ReturnType<typeof setTimeout> | undefined;
66+
// (undocumented)
67+
$requestCleanups$(job: AsyncJob<T>, reason?: any): Promise<void | null>;
68+
$runCleanups$(job: AsyncJob<T>): Promise<void>;
69+
// (undocumented)
70+
$runComputation$(running: AsyncJob<T>): Promise<void>;
71+
$scheduleEagerCleanup$(): void;
72+
// (undocumented)
73+
$timeoutMs$: number | undefined;
74+
// (undocumented)
75+
$untrackedError$: Error | undefined;
76+
// (undocumented)
77+
$untrackedLoading$: boolean;
78+
// (undocumented)
79+
[_EFFECT_BACK_REF]: Map<_EffectProperty | string, EffectSubscription> | undefined;
80+
// Warning: (ae-forgotten-export) The symbol "SignalFlags" needs to be exported by the entry point index.d.ts
81+
// Warning: (ae-forgotten-export) The symbol "SerializationSignalFlags" needs to be exported by the entry point index.d.ts
82+
constructor(container: _Container | null, fn: AsyncQRL<T>, flags?: SignalFlags | SerializationSignalFlags, options?: AsyncSignalOptions<T>);
83+
abort(reason?: any): void;
84+
get error(): Error | undefined;
85+
// (undocumented)
86+
get interval(): number;
87+
set interval(value: number);
88+
invalidate(info?: unknown): Promise<void>;
89+
get loading(): boolean;
90+
promise(): Promise<void>;
91+
set untrackedError(value: Error | undefined);
92+
// (undocumented)
93+
get untrackedError(): Error | undefined;
94+
set untrackedLoading(value: boolean);
95+
// (undocumented)
96+
get untrackedLoading(): boolean;
97+
// (undocumented)
98+
get untrackedValue(): T;
99+
set untrackedValue(value: T);
100+
get value(): T;
101+
set value(value: T);
102+
}
103+
34104
// @public (undocumented)
35105
export interface AsyncSignalOptions<T> extends ComputedOptions {
36106
allowStale?: boolean;
@@ -125,7 +195,7 @@ export const _CONST_PROPS: unique symbol;
125195
// @internal (undocumented)
126196
export interface _Container {
127197
// (undocumented)
128-
$appendStyle$(content: string, styleId: string, host: HostElement, scoped: boolean): void;
198+
$appendStyle$(content: string, styleId: string, host: _HostElement, scoped: boolean): void;
129199
// (undocumented)
130200
$buildBase$: string | null;
131201
// (undocumented)
@@ -150,17 +220,15 @@ export interface _Container {
150220
readonly $storeProxyMap$: ObjToProxyMap;
151221
// (undocumented)
152222
readonly $version$: string;
153-
ensureProjectionResolved(host: HostElement): void;
223+
ensureProjectionResolved(host: _HostElement): void;
154224
// (undocumented)
155-
getHostProp<T>(host: HostElement, name: string): T | null;
225+
getHostProp<T>(host: _HostElement, name: string): T | null;
156226
// (undocumented)
157-
getParentHost(host: HostElement): HostElement | null;
158-
// Warning: (ae-forgotten-export) The symbol "HostElement" needs to be exported by the entry point index.d.ts
159-
//
227+
getParentHost(host: _HostElement): _HostElement | null;
160228
// (undocumented)
161-
handleError(err: any, $host$: HostElement | null): void;
229+
handleError(err: any, $host$: _HostElement | null): void;
162230
// (undocumented)
163-
resolveContext<T>(host: HostElement, contextId: ContextId<T>): T | undefined;
231+
resolveContext<T>(host: _HostElement, contextId: ContextId<T>): T | undefined;
164232
// Warning: (ae-forgotten-export) The symbol "SymbolToChunkResolver" needs to be exported by the entry point index.d.ts
165233
// Warning: (ae-forgotten-export) The symbol "SerializationContext" needs to be exported by the entry point index.d.ts
166234
//
@@ -175,9 +243,9 @@ export interface _Container {
175243
};
176244
} | null, symbolToChunkResolver: SymbolToChunkResolver, writer?: StreamWriter): SerializationContext;
177245
// (undocumented)
178-
setContext<T>(host: HostElement, context: ContextId<T>, value: T): void;
246+
setContext<T>(host: _HostElement, context: ContextId<T>, value: T): void;
179247
// (undocumented)
180-
setHostProp<T>(host: HostElement, name: string, value: T): void;
248+
setHostProp<T>(host: _HostElement, name: string, value: T): void;
181249
}
182250

183251
// @internal (undocumented)
@@ -213,16 +281,14 @@ export interface CorrectedToggleEvent extends Event {
213281
// @public
214282
export const createAsync$: <T>(qrl: (arg: AsyncCtx<T>) => Promise<T>, options?: AsyncSignalOptions<T>) => AsyncSignal<T>;
215283

216-
// Warning: (ae-forgotten-export) The symbol "AsyncSignalImpl" needs to be exported by the entry point index.d.ts
217284
// Warning: (ae-internal-missing-underscore) The name "createAsyncQrl" should be prefixed with an underscore because the declaration is marked as @internal
218285
//
219286
// @internal (undocumented)
220-
export const createAsyncQrl: <T>(qrl: QRL<AsyncFn<T>>, options?: AsyncSignalOptions<T>) => AsyncSignalImpl<T>;
287+
export const createAsyncQrl: <T>(qrl: QRL<AsyncFn<T>>, options?: AsyncSignalOptions<T>) => _AsyncSignalImpl<T>;
221288

222289
// @public
223290
export const createComputed$: <T>(qrl: () => T, options?: ComputedOptions) => ComputedReturnType<T>;
224291

225-
// Warning: (ae-forgotten-export) The symbol "ComputedSignalImpl" needs to be exported by the entry point index.d.ts
226292
// Warning: (ae-internal-missing-underscore) The name "createComputedQrl" should be prefixed with an underscore because the declaration is marked as @internal
227293
//
228294
// @internal (undocumented)
@@ -256,11 +322,17 @@ export const createSignal: {
256322
<T>(value: T): Signal<T>;
257323
};
258324

325+
// @internal (undocumented)
326+
export function _createStore<T extends object>(container: _Container | null | undefined, obj: T, flags: _StoreFlags): T;
327+
259328
// @public (undocumented)
260329
export interface CSSProperties extends CSS_2.Properties<string | number>, CSS_2.PropertiesHyphen<string | number> {
261330
[v: `--${string}`]: string | number | undefined;
262331
}
263332

333+
// @internal (undocumented)
334+
export const _delay: (timeout: number) => Promise<unknown>;
335+
264336
// @internal
265337
export function _deserialize<T>(rawStateData: string): T;
266338

@@ -311,7 +383,7 @@ class DomContainer extends _SharedContainer implements ClientContainer {
311383
// (undocumented)
312384
ensureProjectionResolved(vNode: _VirtualVNode): void;
313385
// (undocumented)
314-
getHostProp<T>(host: HostElement, name: string): T | null;
386+
getHostProp<T>(host: _HostElement, name: string): T | null;
315387
// (undocumented)
316388
getParentHost(host: _VNode): _VNode | null;
317389
// (undocumented)
@@ -331,7 +403,7 @@ class DomContainer extends _SharedContainer implements ClientContainer {
331403
// (undocumented)
332404
setContext<T>(host: _VNode, context: ContextId<T>, value: T): void;
333405
// (undocumented)
334-
setHostProp<T>(host: HostElement, name: string, value: T): void;
406+
setHostProp<T>(host: _HostElement, name: string, value: T): void;
335407
// (undocumented)
336408
vNodeLocate: (id: string | Element) => _VNode;
337409
}
@@ -359,6 +431,17 @@ export const _eaT: (input: TaskCtx) => Promise<void>;
359431
// @internal (undocumented)
360432
export const _EFFECT_BACK_REF: unique symbol;
361433

434+
// @internal (undocumented)
435+
export const enum _EffectProperty {
436+
// (undocumented)
437+
COMPONENT = ":",
438+
// (undocumented)
439+
VNODE = "."
440+
}
441+
442+
// @internal (undocumented)
443+
export const _ELEMENT_SEQ = "q:seq";
444+
362445
// @internal (undocumented)
363446
export class _ElementVNode extends _VirtualVNode {
364447
// Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
@@ -433,7 +516,7 @@ export const _getContextContainer: () => _Container | undefined;
433516
export const _getContextEvent: () => unknown;
434517

435518
// @internal (undocumented)
436-
export const _getContextHostElement: () => HostElement | undefined;
519+
export const _getContextHostElement: () => _HostElement | undefined;
437520

438521
// Warning: (ae-incompatible-release-tags) The symbol "getDomContainer" is marked as @public, but its signature references "ClientContainer" which is marked as @internal
439522
//
@@ -451,6 +534,11 @@ export const getPlatform: () => CorePlatform;
451534
// @internal (undocumented)
452535
export function _getQContainerElement(element: Element): Element | null;
453536

537+
// Warning: (ae-forgotten-export) The symbol "Consumer" needs to be exported by the entry point index.d.ts
538+
//
539+
// @internal (undocumented)
540+
export function _getSubscriber(effect: Consumer, prop: _EffectProperty | string, data?: _SubscriptionData): EffectSubscription;
541+
454542
// @internal
455543
export const _getVarProps: (props: PropsProxy | Record<string, unknown> | null | undefined) => Props | null;
456544

@@ -468,6 +556,9 @@ export const _hmr: (this: string | undefined, event: CustomEvent<{
468556
t: number;
469557
}>, element: Element) => void;
470558

559+
// @internal (undocumented)
560+
export type _HostElement = _VNode | ISsrNode;
561+
471562
// Warning: (ae-forgotten-export) The symbol "HTMLAttributesBase" needs to be exported by the entry point index.d.ts
472563
// Warning: (ae-forgotten-export) The symbol "FilterBase" needs to be exported by the entry point index.d.ts
473564
//
@@ -493,6 +584,11 @@ export const inlinedQrl: <T>(symbol: T | null, symbolName: string, lexicalScopeC
493584
// @internal (undocumented)
494585
export const inlinedQrlDEV: <T = any>(symbol: T, symbolName: string, opts: QRLDev, lexicalScopeCapture?: Readonly<unknown[]>) => QRL<T>;
495586

587+
// Warning: (ae-forgotten-export) The symbol "InvokeContext" needs to be exported by the entry point index.d.ts
588+
//
589+
// @internal
590+
export function _invoke<FN extends (...args: any[]) => any>(this: unknown, context: InvokeContext | undefined, fn: FN, ...args: Parameters<FN>): ReturnType<FN>;
591+
496592
export { isBrowser }
497593

498594
export { isDev }
@@ -535,10 +631,8 @@ export const _isStore: (value: object) => boolean;
535631
// @internal (undocumented)
536632
export function _isStringifiable(value: unknown): value is _Stringifiable;
537633

538-
// Warning: (ae-forgotten-export) The symbol "Task" needs to be exported by the entry point index.d.ts
539-
//
540634
// @internal (undocumented)
541-
export const _isTask: (value: any) => value is Task;
635+
export const _isTask: (value: any) => value is _Task;
542636

543637
// Warning: (ae-forgotten-export) The symbol "JsxDevOpts" needs to be exported by the entry point index.d.ts
544638
//
@@ -660,6 +754,12 @@ export type NativeUIEvent = UIEvent;
660754
// @public @deprecated (undocumented)
661755
export type NativeWheelEvent = WheelEvent;
662756

757+
// Warning: (ae-forgotten-export) The symbol "PossibleEvents" needs to be exported by the entry point index.d.ts
758+
// Warning: (ae-forgotten-export) The symbol "RenderEvent" needs to be exported by the entry point index.d.ts
759+
//
760+
// @internal (undocumented)
761+
export function _newInvokeContext(locale?: string, hostElement?: _HostElement, event?: Exclude<PossibleEvents, typeof RenderEvent>): InvokeContext;
762+
663763
// @internal (undocumented)
664764
export const _noopQrl: <T>(symbolName: string, lexicalScopeCapture?: Readonly<unknown[]>) => QRL<T>;
665765

@@ -997,6 +1097,9 @@ export type ResourceReturn<T> = {
9971097
// @internal (undocumented)
9981098
export const _restProps: (props: PropsProxy, omit?: string[], target?: Props) => Props;
9991099

1100+
// @internal
1101+
export function _retryOnPromise<T>(fn: () => ValueOrPromise<T>, onError?: (e: any) => ValueOrPromise<T>): ValueOrPromise<T>;
1102+
10001103
// @internal
10011104
export const _rsc: <T>(arg: ResourceCtx<T>) => Promise<{
10021105
r: T;
@@ -1026,7 +1129,7 @@ export function _setProjectionTarget(vnode: _VirtualVNode, targetElement: Elemen
10261129
// @internal (undocumented)
10271130
export abstract class _SharedContainer implements _Container {
10281131
// (undocumented)
1029-
abstract $appendStyle$(content: string, styleId: string, host: HostElement, scoped: boolean): void;
1132+
abstract $appendStyle$(content: string, styleId: string, host: _HostElement, scoped: boolean): void;
10301133
// (undocumented)
10311134
$buildBase$: string | null;
10321135
// (undocumented)
@@ -1053,15 +1156,15 @@ export abstract class _SharedContainer implements _Container {
10531156
readonly $version$: string;
10541157
constructor(serverData: Record<string, any>, locale: string);
10551158
// (undocumented)
1056-
abstract ensureProjectionResolved(host: HostElement): void;
1159+
abstract ensureProjectionResolved(host: _HostElement): void;
10571160
// (undocumented)
1058-
abstract getHostProp<T>(host: HostElement, name: string): T | null;
1161+
abstract getHostProp<T>(host: _HostElement, name: string): T | null;
10591162
// (undocumented)
1060-
abstract getParentHost(host: HostElement): HostElement | null;
1163+
abstract getParentHost(host: _HostElement): _HostElement | null;
10611164
// (undocumented)
1062-
abstract handleError(err: any, $host$: HostElement | null): void;
1165+
abstract handleError(err: any, $host$: _HostElement | null): void;
10631166
// (undocumented)
1064-
abstract resolveContext<T>(host: HostElement, contextId: ContextId<T>): T | undefined;
1167+
abstract resolveContext<T>(host: _HostElement, contextId: ContextId<T>): T | undefined;
10651168
// (undocumented)
10661169
serializationCtxFactory(NodeConstructor: {
10671170
new (...rest: any[]): {
@@ -1073,11 +1176,11 @@ export abstract class _SharedContainer implements _Container {
10731176
};
10741177
} | null, symbolToChunkResolver: SymbolToChunkResolver, writer?: StreamWriter): SerializationContext;
10751178
// (undocumented)
1076-
abstract setContext<T>(host: HostElement, context: ContextId<T>, value: T): void;
1179+
abstract setContext<T>(host: _HostElement, context: ContextId<T>, value: T): void;
10771180
// (undocumented)
1078-
abstract setHostProp<T>(host: HostElement, name: string, value: T): void;
1181+
abstract setHostProp<T>(host: _HostElement, name: string, value: T): void;
10791182
// (undocumented)
1080-
trackSignalValue<T>(signal: Signal, subscriber: HostElement, property: string, data: _SubscriptionData): T;
1183+
trackSignalValue<T>(signal: Signal, subscriber: _HostElement, property: string, data: _SubscriptionData): T;
10811184
}
10821185

10831186
// @public
@@ -1188,6 +1291,16 @@ export interface SSRStreamWriter {
11881291
write(chunk: JSXOutput): void;
11891292
}
11901293

1294+
// @internal (undocumented)
1295+
export const enum _StoreFlags {
1296+
// (undocumented)
1297+
IMMUTABLE = 2,
1298+
// (undocumented)
1299+
NONE = 0,
1300+
// (undocumented)
1301+
RECURSIVE = 1
1302+
}
1303+
11911304
// Warning: (ae-internal-missing-underscore) The name "StreamWriter" should be prefixed with an underscore because the declaration is marked as @internal
11921305
//
11931306
// @internal (undocumented)
@@ -1750,6 +1863,29 @@ export type SyncQRL<TYPE extends Function> = QRL<TYPE> & {
17501863
dev?: QRLDev | null;
17511864
} & BivariantQrlFn<QrlArgs<TYPE>, QrlReturn<TYPE>>;
17521865

1866+
// Warning: (ae-forgotten-export) The symbol "DescriptorBase" needs to be exported by the entry point index.d.ts
1867+
//
1868+
// @internal (undocumented)
1869+
export class _Task<T = unknown, B = T> extends BackRef implements DescriptorBase<unknown, Signal<B>> {
1870+
// (undocumented)
1871+
$destroy$: (() => void) | null;
1872+
// (undocumented)
1873+
$destroyPromise$: Promise<void> | undefined;
1874+
// (undocumented)
1875+
$el$: _HostElement;
1876+
// (undocumented)
1877+
$flags$: number;
1878+
// (undocumented)
1879+
$index$: number;
1880+
// (undocumented)
1881+
$qrl$: _QRLInternal<T>;
1882+
// (undocumented)
1883+
$state$: Signal<B> | undefined;
1884+
// (undocumented)
1885+
$taskPromise$: Promise<void> | null;
1886+
constructor($flags$: number, $index$: number, $el$: _HostElement, $qrl$: _QRLInternal<T>, $state$: Signal<B> | undefined, $destroy$: (() => void) | null);
1887+
}
1888+
17531889
// @internal
17541890
export function _task(this: string, _event: Event, element: Element): void;
17551891

@@ -1971,8 +2107,6 @@ export class _VirtualVNode extends _VNode {
19712107
// @public (undocumented)
19722108
export type VisibleTaskStrategy = 'intersection-observer' | 'document-ready' | 'document-idle';
19732109

1974-
// Warning: (ae-forgotten-export) The symbol "BackRef" needs to be exported by the entry point index.d.ts
1975-
//
19762110
// @internal (undocumented)
19772111
export abstract class _VNode implements BackRef {
19782112
// (undocumented)
@@ -2020,6 +2154,12 @@ export const _vnode_isTextVNode: (vNode: _VNode) => vNode is _TextVNode;
20202154
// @internal (undocumented)
20212155
export const _vnode_isVirtualVNode: (vNode: _VNode) => vNode is _VirtualVNode;
20222156

2157+
// @internal (undocumented)
2158+
export const _vnode_newVirtual: () => _VirtualVNode;
2159+
2160+
// @internal (undocumented)
2161+
export const _vnode_setProp: (vNode: _VNode, key: string, value: unknown) => void;
2162+
20232163
// @internal (undocumented)
20242164
export function _vnode_toString(this: _VNode | null, depth?: number, offset?: string, materialize?: boolean, siblings?: boolean, colorize?: boolean, container?: _Container | null): string;
20252165

0 commit comments

Comments
 (0)