feat: export isStore and isTask functions; update API documentation

packages/qwik/src/core/client/util-mapArray.ts

@@ -1,5 +1,6 @@
 import { assertTrue } from '../shared/error/assert';
 
+/** @internal */
 export const mapApp_findIndx = <T>(array: (T | null)[], key: string, start: number): number => {
   assertTrue(start % 2 === 0, 'Expecting even number.');
   let bottom = (start as number) >> 1;
@@ -19,6 +20,7 @@ export const mapApp_findIndx = <T>(array: (T | null)[], key: string, start: numb
   return (bottom << 1) ^ -1;
 };
 
+/** @internal */
 export const mapArray_set = <T>(
   array: (T | null)[],
   key: string,
@@ -48,6 +50,7 @@ export const mapApp_remove = <T>(array: (T | null)[], key: string, start: number
   return value;
 };
 
+/** @internal */
 export const mapArray_get = <T>(array: (T | null)[], key: string, start: number): T | null => {
   const indx = mapApp_findIndx(array, key, start);
   if (indx >= 0) {

packages/qwik/src/core/client/vnode.ts

@@ -317,6 +317,7 @@ export const vnode_isElementOrVirtualVNode = (
   return (flag & VNodeFlags.ELEMENT_OR_VIRTUAL_MASK) !== 0;
 };
 
+/** @internal */
 export const vnode_isMaterialized = (vNode: VNode): boolean => {
   assertDefined(vNode, 'Missing vNode');
   const flag = (vNode as VNode)[VNodeProps.flags];
@@ -327,12 +328,14 @@ export const vnode_isMaterialized = (vNode: VNode): boolean => {
   );
 };
 
+/** @internal */
 export const vnode_isTextVNode = (vNode: VNode): vNode is TextVNode => {
   assertDefined(vNode, 'Missing vNode');
   const flag = (vNode as VNode)[VNodeProps.flags];
   return (flag & VNodeFlags.Text) === VNodeFlags.Text;
 };
 
+/** @internal */
 export const vnode_isVirtualVNode = (vNode: VNode): vNode is VirtualVNode => {
   assertDefined(vNode, 'Missing vNode');
   const flag = (vNode as VNode)[VNodeProps.flags];
@@ -384,6 +387,7 @@ export const vnode_getNodeTypeName = (vNode: VNode): string => {
   return '<unknown>';
 };
 
+/** @internal */
 export const vnode_ensureElementInflated = (vnode: VNode) => {
   const flags = vnode[VNodeProps.flags];
   if ((flags & VNodeFlags.INFLATED_TYPE_MASK) === VNodeFlags.Element) {
@@ -1233,6 +1237,7 @@ export const vnode_setText = (journal: VNodeJournal, textVNode: TextVNode, text:
   journal.push(VNodeJournalOpCode.SetText, textNode, (textVNode[TextVNodeProps.text] = text));
 };
 
+/** @internal */
 export const vnode_getFirstChild = (vnode: VNode): VNode | null => {
   if (vnode_isTextVNode(vnode)) {
     return null;
@@ -1592,6 +1597,7 @@ const processVNodeData = (
   }
 };
 
+/** @internal */
 export const vnode_getNextSibling = (vnode: VNode): VNode | null => {
   return vnode[VNodeProps.nextSibling];
 };
@@ -1600,6 +1606,7 @@ export const vnode_getPreviousSibling = (vnode: VNode): VNode | null => {
   return vnode[VNodeProps.previousSibling];
 };
 
+/** @internal */
 export const vnode_getAttrKeys = (vnode: ElementVNode | VirtualVNode): string[] => {
   const type = vnode[VNodeProps.flags];
   if ((type & VNodeFlags.ELEMENT_OR_VIRTUAL_MASK) !== 0) {
@@ -1651,6 +1658,7 @@ export const vnode_setAttr = (
   }
 };
 
+/** @internal */
 export const vnode_getAttr = (vnode: VNode, key: string): string | null => {
   const type = vnode[VNodeProps.flags];
   if ((type & VNodeFlags.ELEMENT_OR_VIRTUAL_MASK) !== 0) {
@@ -1693,6 +1701,7 @@ export const vnode_setProp = (vnode: VirtualVNode | ElementVNode, key: string, v
   }
 };
 
+/** @internal */
 export const vnode_getPropStartIndex = (vnode: VNode): number => {
   const type = vnode[VNodeProps.flags] & VNodeFlags.TYPE_MASK;
   if (type === VNodeFlags.Element) {
@@ -1703,6 +1712,7 @@ export const vnode_getPropStartIndex = (vnode: VNode): number => {
   throw qError(QError.invalidVNodeType, [type]);
 };
 
+/** @internal */
 export const vnode_getProps = (vnode: VNode): unknown[] => {
   return vnode[vnode_getPropStartIndex(vnode)] as unknown[];
 };

packages/qwik/src/core/internal.ts

@@ -15,7 +15,25 @@ export type {
   VNode as _VNode,
   VNodeFlags as _VNodeFlags,
 } from './client/types';
-export { vnode_toString as _vnode_toString } from './client/vnode';
+export {
+  vnode_toString as _vnode_toString,
+  vnode_getPropStartIndex as _vnode_getPropStartIndex,
+  vnode_getProps as _vnode_getProps,
+  vnode_isTextVNode as _vnode_isTextVNode,
+  vnode_isVirtualVNode as _vnode_isVirtualVNode,
+  vnode_getFirstChild as _vnode_getFirstChild,
+  vnode_isMaterialized as _vnode_isMaterialized,
+  vnode_getNextSibling as _vnode_getNextSibling,
+  vnode_ensureElementInflated as _vnode_ensureElementInflated,
+  vnode_getAttrKeys as _vnode_getAttrKeys,
+  vnode_getAttr as _vnode_getAttr,
+} from './client/vnode';
+export {
+  mapApp_findIndx as _mapApp_findIndx,
+  mapArray_get as _mapArray_get,
+  mapArray_set as _mapArray_set,
+} from './client/util-mapArray';
+
 export { _wrapProp, _wrapSignal } from './reactive-primitives/internal-api';
 export { SubscriptionData as _SubscriptionData } from './reactive-primitives/subscription-data';
 export { _EFFECT_BACK_REF } from './reactive-primitives/types';
@@ -52,5 +70,6 @@ export {
   _jsxBranch,
   _waitUntilRendered,
 } from './use/use-core';
-export { scheduleTask as _task } from './use/use-task';
+export { scheduleTask as _task, isTask as _isTask } from './use/use-task';
+export { isStore as _isStore } from './reactive-primitives/impl/store';
 export { _resolveContextWithoutSequentialScope } from './use/use-context';

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

@@ -427,9 +427,19 @@ export interface ISsrComponentFrame {
     scopedStyleIds: Set<string>;
 }
 
+// Warning: (ae-forgotten-export) The symbol "StoreTarget" needs to be exported by the entry point index.d.ts
+//
+// @internal (undocumented)
+export const _isStore: (value: StoreTarget) => boolean;
+
 // @internal (undocumented)
 export function _isStringifiable(value: unknown): value is _Stringifiable;
 
+// Warning: (ae-forgotten-export) The symbol "Task" needs to be exported by the entry point index.d.ts
+//
+// @internal (undocumented)
+export const _isTask: (value: any) => value is Task;
+
 // Warning: (ae-forgotten-export) The symbol "Props" needs to be exported by the entry point index.d.ts
 //
 // @public
@@ -501,6 +511,15 @@ export type JSXTagName = keyof HTMLElementTagNameMap | Omit<string, keyof HTMLEl
 // @public
 export type KnownEventNames = LiteralUnion<AllEventKeys, string>;
 
+// @internal (undocumented)
+export const _mapApp_findIndx: <T>(array: (T | null)[], key: string, start: number) => number;
+
+// @internal (undocumented)
+export const _mapArray_get: <T>(array: (T | null)[], key: string, start: number) => T | null;
+
+// @internal (undocumented)
+export const _mapArray_set: <T>(array: (T | null)[], key: string, value: T | null, start: number) => void;
+
 // @public @deprecated (undocumented)
 export type NativeAnimationEvent = AnimationEvent;
 
@@ -1828,6 +1847,36 @@ export type VisibleTaskStrategy = 'intersection-observer' | 'document-ready' | '
 // @internal (undocumented)
 export type _VNode = _ElementVNode | _TextVNode | _VirtualVNode;
 
+// @internal (undocumented)
+export const _vnode_ensureElementInflated: (vnode: _VNode) => void;
+
+// @internal (undocumented)
+export const _vnode_getAttr: (vnode: _VNode, key: string) => string | null;
+
+// @internal (undocumented)
+export const _vnode_getAttrKeys: (vnode: _ElementVNode | _VirtualVNode) => string[];
+
+// @internal (undocumented)
+export const _vnode_getFirstChild: (vnode: _VNode) => _VNode | null;
+
+// @internal (undocumented)
+export const _vnode_getNextSibling: (vnode: _VNode) => _VNode | null;
+
+// @internal (undocumented)
+export const _vnode_getProps: (vnode: _VNode) => unknown[];
+
+// @internal (undocumented)
+export const _vnode_getPropStartIndex: (vnode: _VNode) => number;
+
+// @internal (undocumented)
+export const _vnode_isMaterialized: (vNode: _VNode) => boolean;
+
+// @internal (undocumented)
+export const _vnode_isTextVNode: (vNode: _VNode) => vNode is _TextVNode;
+
+// @internal (undocumented)
+export const _vnode_isVirtualVNode: (vNode: _VNode) => vNode is _VirtualVNode;
+
 // @internal (undocumented)
 export function _vnode_toString(this: _VNode | null, depth?: number, offset?: string, materialize?: boolean, siblings?: boolean, colorize?: boolean): string;
 

packages/qwik/src/core/reactive-primitives/impl/store.ts

@@ -41,6 +41,7 @@ export const unwrapStore = <T>(value: T): T => {
   return getStoreTarget<any>(value) || value;
 };
 
+/** @internal */
 export const isStore = (value: StoreTarget): boolean => {
   return STORE_TARGET in value;
 };

packages/qwik/src/core/reactive-primitives/signal.public.ts

@@ -8,7 +8,6 @@ import {
 } from './signal-api';
 import type { ComputedReturnType } from '../use/use-computed';
 import type { AsyncComputedReturnType } from '../use/use-async-computed';
-
 export { isSignal } from './utils';
 
 /** @public */

packages/qwik/src/core/use/use-task.ts

@@ -220,7 +220,7 @@ export class Task<T = unknown, B = T>
     super();
   }
 }
-
+/** @internal */
 export const isTask = (value: any): value is Task => {
   return value instanceof Task;
 };