Skip to content

Commit 2e08fc7

Browse files
authored
Merge pull request #8193 from JerryWu1234/build/v2
feat(api): add QRLInternal type and update documentation
2 parents 920f1a4 + 27d4724 commit 2e08fc7

File tree

4 files changed

+12
-0
lines changed

4 files changed

+12
-0
lines changed

.changeset/spicy-rings-check.md

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
---
2+
'@qwik.dev/core': patch
3+
---
4+
5+
FEAT: Introduced the QRLInternal type

packages/qwik/src/core/internal.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,5 @@
11
export { _noopQrl, _noopQrlDEV, _regSymbol } from './shared/qrl/qrl';
2+
export type { QRLInternal as _QRLInternal } from './shared/qrl/qrl-class';
23
// ^ keep this above to avoid circular dependency issues
34

45
export {

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

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -664,6 +664,11 @@ export const qrlDEV: <T = any>(chunkOrFn: string | (() => Promise<any>), symbol:
664664
// @public
665665
export type QRLEventHandlerMulti<EV extends Event, EL> = QRL<EventHandler<EV, EL>> | undefined | null | QRLEventHandlerMulti<EV, EL>[];
666666

667+
// Warning: (ae-forgotten-export) The symbol "QRLInternalMethods" needs to be exported by the entry point index.d.ts
668+
//
669+
// @internal (undocumented)
670+
export type _QRLInternal<TYPE = unknown> = QRL<TYPE> & QRLInternalMethods<TYPE>;
671+
667672
// @internal
668673
export const _qrlSync: <TYPE extends Function>(fn: TYPE, serializedFn?: string) => SyncQRL<TYPE>;
669674

packages/qwik/src/core/shared/qrl/qrl-class.ts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -56,6 +56,7 @@ export type QRLInternalMethods<TYPE> = {
5656
$setContainer$(containerEl: Element | undefined): Element | undefined;
5757
};
5858

59+
/** @internal */
5960
export type QRLInternal<TYPE = unknown> = QRL<TYPE> & QRLInternalMethods<TYPE>;
6061

6162
const resolvedSymbol = Symbol('resolved');

0 commit comments

Comments
 (0)