@vue/shared 3.6.0-beta.4 → 3.6.0-beta.5

package/dist/shared.d.ts

@@ -1,24 +1,26 @@
+//#region temp/packages/shared/src/makeMap.d.ts
 /**
- * Make a map and return a function for checking if a key
- * is in that map.
- * IMPORTANT: all calls of this function must be prefixed with
- * \/\*#\_\_PURE\_\_\*\/
- * So that rollup can tree-shake them if necessary.
- */
+* Make a map and return a function for checking if a key
+* is in that map.
+* IMPORTANT: all calls of this function must be prefixed with
+* \/\*#\_\_PURE\_\_\*\/
+* So that they can be tree-shaken if necessary.
+*/
 export declare function makeMap(str: string): (key: string) => boolean;
-
+//#endregion
+//#region temp/packages/shared/src/general.d.ts
 export declare const EMPTY_OBJ: {
-    readonly [key: string]: any;
+  readonly [key: string]: any;
 };
 export declare const EMPTY_ARR: readonly never[];
 export declare const NOOP: () => void;
 /**
- * Always return true.
- */
+* Always return true.
+*/
 export declare const YES: () => boolean;
 /**
- * Always return false.
- */
+* Always return false.
+*/
 export declare const NO: () => boolean;
 export declare const isOn: (key: string) => boolean;
 export declare const isNativeOn: (key: string) => boolean;
@@ -45,334 +47,344 @@ export declare const isReservedProp: (key: string) => boolean;
 export declare const isBuiltInTag: (key: string) => boolean;
 export declare const isBuiltInDirective: (key: string) => boolean;
 /**
- * @private
- */
+* @private
+*/
 export declare const camelize: (str: string) => string;
 /**
- * @private
- */
+* @private
+*/
 export declare const hyphenate: (str: string) => string;
 /**
- * @private
- */
+* @private
+*/
 export declare const capitalize: <T extends string>(str: T) => Capitalize<T>;
 /**
- * @private
- */
-export declare const toHandlerKey: <T extends string>(str: T) => T extends '' ? '' : `on${Capitalize<T>}`;
+* @private
+*/
+export declare const toHandlerKey: <T extends string>(str: T) => T extends "" ? "" : `on${Capitalize<T>}`;
 /**
- * #13070 When v-model and v-model:model directives are used together,
- * they will generate the same modelModifiers prop,
- * so a `$` suffix is added to avoid conflicts.
- * @private
- */
+* #13070 When v-model and v-model:model directives are used together,
+* they will generate the same modelModifiers prop,
+* so a `$` suffix is added to avoid conflicts.
+* @private
+*/
 export declare const getModifierPropName: (name: string) => string;
 export declare const hasChanged: (value: any, oldValue: any) => boolean;
 export declare const invokeArrayFns: (fns: Function[], ...arg: any[]) => void;
 export declare const def: (obj: object, key: string | symbol, value: any, writable?: boolean) => void;
 /**
- * "123-foo" will be parsed to 123
- * This is used for the .number modifier in v-model
- */
+* "123-foo" will be parsed to 123
+* This is used for the .number modifier in v-model
+*/
 export declare const looseToNumber: (val: any) => any;
 /**
- * Only concerns number-like strings
- * "123-foo" will be returned as-is
- */
+* Only concerns number-like strings
+* "123-foo" will be returned as-is
+*/
 export declare const toNumber: (val: any) => any;
 export declare const getGlobalThis: () => any;
 export declare function genPropsAccessExp(name: string): string;
 export declare function genCacheKey(source: string, options: any): string;
 export declare function canSetValueDirectly(tagName: string): boolean;
-
+//#endregion
+//#region temp/packages/shared/src/patchFlags.d.ts
 /**
- * Patch flags are optimization hints generated by the compiler.
- * when a block with dynamicChildren is encountered during diff, the algorithm
- * enters "optimized mode". In this mode, we know that the vdom is produced by
- * a render function generated by the compiler, so the algorithm only needs to
- * handle updates explicitly marked by these patch flags.
- *
- * Patch flags can be combined using the | bitwise operator and can be checked
- * using the & operator, e.g.
- *
- * ```js
- * const flag = TEXT | CLASS
- * if (flag & TEXT) { ... }
- * ```
- *
- * Check the `patchElement` function in '../../runtime-core/src/renderer.ts' to see how the
- * flags are handled during diff.
- */
+* Patch flags are optimization hints generated by the compiler.
+* when a block with dynamicChildren is encountered during diff, the algorithm
+* enters "optimized mode". In this mode, we know that the vdom is produced by
+* a render function generated by the compiler, so the algorithm only needs to
+* handle updates explicitly marked by these patch flags.
+*
+* Patch flags can be combined using the | bitwise operator and can be checked
+* using the & operator, e.g.
+*
+* ```js
+* const flag = TEXT | CLASS
+* if (flag & TEXT) { ... }
+* ```
+*
+* Check the `patchElement` function in '../../runtime-core/src/renderer.ts' to see how the
+* flags are handled during diff.
+*/
 export declare enum PatchFlags {
-    /**
-     * Indicates an element with dynamic textContent (children fast path)
-     */
-    TEXT = 1,
-    /**
-     * Indicates an element with dynamic class binding.
-     */
-    CLASS = 2,
-    /**
-     * Indicates an element with dynamic style
-     * The compiler pre-compiles static string styles into static objects
-     * + detects and hoists inline static objects
-     * e.g. `style="color: red"` and `:style="{ color: 'red' }"` both get hoisted
-     * as:
-     * ```js
-     * const style = { color: 'red' }
-     * render() { return e('div', { style }) }
-     * ```
-     */
-    STYLE = 4,
-    /**
-     * Indicates an element that has non-class/style dynamic props.
-     * Can also be on a component that has any dynamic props (includes
-     * class/style). when this flag is present, the vnode also has a dynamicProps
-     * array that contains the keys of the props that may change so the runtime
-     * can diff them faster (without having to worry about removed props)
-     */
-    PROPS = 8,
-    /**
-     * Indicates an element with props with dynamic keys. When keys change, a full
-     * diff is always needed to remove the old key. This flag is mutually
-     * exclusive with CLASS, STYLE and PROPS.
-     */
-    FULL_PROPS = 16,
-    /**
-     * Indicates an element that requires props hydration
-     * (but not necessarily patching)
-     * e.g. event listeners & v-bind with prop modifier
-     */
-    NEED_HYDRATION = 32,
-    /**
-     * Indicates a fragment whose children order doesn't change.
-     */
-    STABLE_FRAGMENT = 64,
-    /**
-     * Indicates a fragment with keyed or partially keyed children
-     */
-    KEYED_FRAGMENT = 128,
-    /**
-     * Indicates a fragment with unkeyed children.
-     */
-    UNKEYED_FRAGMENT = 256,
-    /**
-     * Indicates an element that only needs non-props patching, e.g. ref or
-     * directives (onVnodeXXX hooks). since every patched vnode checks for refs
-     * and onVnodeXXX hooks, it simply marks the vnode so that a parent block
-     * will track it.
-     */
-    NEED_PATCH = 512,
-    /**
-     * Indicates a component with dynamic slots (e.g. slot that references a v-for
-     * iterated value, or dynamic slot names).
-     * Components with this flag are always force updated.
-     */
-    DYNAMIC_SLOTS = 1024,
-    /**
-     * Indicates a fragment that was created only because the user has placed
-     * comments at the root level of a template. This is a dev-only flag since
-     * comments are stripped in production.
-     */
-    DEV_ROOT_FRAGMENT = 2048,
-    /**
-     * SPECIAL FLAGS -------------------------------------------------------------
-     * Special flags are negative integers. They are never matched against using
-     * bitwise operators (bitwise matching should only happen in branches where
-     * patchFlag > 0), and are mutually exclusive. When checking for a special
-     * flag, simply check patchFlag === FLAG.
-     */
-    /**
-     * Indicates a cached static vnode. This is also a hint for hydration to skip
-     * the entire sub tree since static content never needs to be updated.
-     */
-    CACHED = -1,
-    /**
-     * A special flag that indicates that the diffing algorithm should bail out
-     * of optimized mode. For example, on block fragments created by renderSlot()
-     * when encountering non-compiler generated slots (i.e. manually written
-     * render functions, which should always be fully diffed)
-     * OR manually cloneVNodes
-     */
-    BAIL = -2
+  /**
+  * Indicates an element with dynamic textContent (children fast path)
+  */
+  TEXT = 1,
+  /**
+  * Indicates an element with dynamic class binding.
+  */
+  CLASS = 2,
+  /**
+  * Indicates an element with dynamic style
+  * The compiler pre-compiles static string styles into static objects
+  * + detects and hoists inline static objects
+  * e.g. `style="color: red"` and `:style="{ color: 'red' }"` both get hoisted
+  * as:
+  * ```js
+  * const style = { color: 'red' }
+  * render() { return e('div', { style }) }
+  * ```
+  */
+  STYLE = 4,
+  /**
+  * Indicates an element that has non-class/style dynamic props.
+  * Can also be on a component that has any dynamic props (includes
+  * class/style). when this flag is present, the vnode also has a dynamicProps
+  * array that contains the keys of the props that may change so the runtime
+  * can diff them faster (without having to worry about removed props)
+  */
+  PROPS = 8,
+  /**
+  * Indicates an element with props with dynamic keys. When keys change, a full
+  * diff is always needed to remove the old key. This flag is mutually
+  * exclusive with CLASS, STYLE and PROPS.
+  */
+  FULL_PROPS = 16,
+  /**
+  * Indicates an element that requires props hydration
+  * (but not necessarily patching)
+  * e.g. event listeners & v-bind with prop modifier
+  */
+  NEED_HYDRATION = 32,
+  /**
+  * Indicates a fragment whose children order doesn't change.
+  */
+  STABLE_FRAGMENT = 64,
+  /**
+  * Indicates a fragment with keyed or partially keyed children
+  */
+  KEYED_FRAGMENT = 128,
+  /**
+  * Indicates a fragment with unkeyed children.
+  */
+  UNKEYED_FRAGMENT = 256,
+  /**
+  * Indicates an element that only needs non-props patching, e.g. ref or
+  * directives (onVnodeXXX hooks). since every patched vnode checks for refs
+  * and onVnodeXXX hooks, it simply marks the vnode so that a parent block
+  * will track it.
+  */
+  NEED_PATCH = 512,
+  /**
+  * Indicates a component with dynamic slots (e.g. slot that references a v-for
+  * iterated value, or dynamic slot names).
+  * Components with this flag are always force updated.
+  */
+  DYNAMIC_SLOTS = 1024,
+  /**
+  * Indicates a fragment that was created only because the user has placed
+  * comments at the root level of a template. This is a dev-only flag since
+  * comments are stripped in production.
+  */
+  DEV_ROOT_FRAGMENT = 2048,
+  /**
+  * SPECIAL FLAGS -------------------------------------------------------------
+  * Special flags are negative integers. They are never matched against using
+  * bitwise operators (bitwise matching should only happen in branches where
+  * patchFlag > 0), and are mutually exclusive. When checking for a special
+  * flag, simply check patchFlag === FLAG.
+  */
+  /**
+  * Indicates a cached static vnode. This is also a hint for hydration to skip
+  * the entire sub tree since static content never needs to be updated.
+  */
+  CACHED = -1,
+  /**
+  * A special flag that indicates that the diffing algorithm should bail out
+  * of optimized mode. For example, on block fragments created by renderSlot()
+  * when encountering non-compiler generated slots (i.e. manually written
+  * render functions, which should always be fully diffed)
+  * OR manually cloneVNodes
+  */
+  BAIL = -2
 }
 /**
- * dev only flag -> name mapping
- */
+* dev only flag -> name mapping
+*/
 export declare const PatchFlagNames: Record<PatchFlags, string>;
-
+//#endregion
+//#region temp/packages/shared/src/shapeFlags.d.ts
 export declare enum ShapeFlags {
-    ELEMENT = 1,
-    FUNCTIONAL_COMPONENT = 2,
-    STATEFUL_COMPONENT = 4,
-    TEXT_CHILDREN = 8,
-    ARRAY_CHILDREN = 16,
-    SLOTS_CHILDREN = 32,
-    TELEPORT = 64,
-    SUSPENSE = 128,
-    COMPONENT_SHOULD_KEEP_ALIVE = 256,
-    COMPONENT_KEPT_ALIVE = 512,
-    COMPONENT = 6
+  ELEMENT = 1,
+  FUNCTIONAL_COMPONENT = 2,
+  STATEFUL_COMPONENT = 4,
+  TEXT_CHILDREN = 8,
+  ARRAY_CHILDREN = 16,
+  SLOTS_CHILDREN = 32,
+  TELEPORT = 64,
+  SUSPENSE = 128,
+  COMPONENT_SHOULD_KEEP_ALIVE = 256,
+  COMPONENT_KEPT_ALIVE = 512,
+  COMPONENT = 6
 }
-
+//#endregion
+//#region temp/packages/shared/src/slotFlags.d.ts
 export declare enum SlotFlags {
-    /**
-     * Stable slots that only reference slot props or context state. The slot
-     * can fully capture its own dependencies so when passed down the parent won't
-     * need to force the child to update.
-     */
-    STABLE = 1,
-    /**
-     * Slots that reference scope variables (v-for or an outer slot prop), or
-     * has conditional structure (v-if, v-for). The parent will need to force
-     * the child to update because the slot does not fully capture its dependencies.
-     */
-    DYNAMIC = 2,
-    /**
-     * `<slot/>` being forwarded into a child component. Whether the parent needs
-     * to update the child is dependent on what kind of slots the parent itself
-     * received. This has to be refined at runtime, when the child's vnode
-     * is being created (in `normalizeChildren`)
-     */
-    FORWARDED = 3
+  /**
+  * Stable slots that only reference slot props or context state. The slot
+  * can fully capture its own dependencies so when passed down the parent won't
+  * need to force the child to update.
+  */
+  STABLE = 1,
+  /**
+  * Slots that reference scope variables (v-for or an outer slot prop), or
+  * has conditional structure (v-if, v-for). The parent will need to force
+  * the child to update because the slot does not fully capture its dependencies.
+  */
+  DYNAMIC = 2,
+  /**
+  * `<slot/>` being forwarded into a child component. Whether the parent needs
+  * to update the child is dependent on what kind of slots the parent itself
+  * received. This has to be refined at runtime, when the child's vnode
+  * is being created (in `normalizeChildren`)
+  */
+  FORWARDED = 3
 }
 /**
- * Dev only
- */
+* Dev only
+*/
 export declare const slotFlagsText: Record<SlotFlags, string>;
-
+//#endregion
+//#region temp/packages/shared/src/globalsAllowList.d.ts
 export declare const isGloballyAllowed: (key: string) => boolean;
 /** @deprecated use `isGloballyAllowed` instead */
 export declare const isGloballyWhitelisted: (key: string) => boolean;
-
+//#endregion
+//#region temp/packages/shared/src/codeframe.d.ts
 export declare function generateCodeFrame(source: string, start?: number, end?: number): string;
-
+//#endregion
+//#region temp/packages/shared/src/normalizeProp.d.ts
 export type NormalizedStyle = Record<string, unknown>;
 export declare function normalizeStyle(value: unknown): NormalizedStyle | string | undefined;
 export declare function parseStringStyle(cssText: string): NormalizedStyle;
 export declare function stringifyStyle(styles: NormalizedStyle | string | undefined): string;
 export declare function normalizeClass(value: unknown): string;
 export declare function normalizeProps(props: Record<string, any> | null): Record<string, any> | null;
-
+//#endregion
+//#region temp/packages/shared/src/domTagConfig.d.ts
 /**
- * Compiler only.
- * Do NOT use in runtime code paths unless behind `__DEV__` flag.
- */
+* Compiler only.
+* Do NOT use in runtime code paths unless behind `__DEV__` flag.
+*/
 export declare const isHTMLTag: (key: string) => boolean;
 /**
- * Compiler only.
- * Do NOT use in runtime code paths unless behind `__DEV__` flag.
- */
+* Compiler only.
+* Do NOT use in runtime code paths unless behind `__DEV__` flag.
+*/
 export declare const isSVGTag: (key: string) => boolean;
 /**
- * Compiler only.
- * Do NOT use in runtime code paths unless behind `__DEV__` flag.
- */
+* Compiler only.
+* Do NOT use in runtime code paths unless behind `__DEV__` flag.
+*/
 export declare const isMathMLTag: (key: string) => boolean;
 /**
- * Compiler only.
- * Do NOT use in runtime code paths unless behind `__DEV__` flag.
- */
+* Compiler only.
+* Do NOT use in runtime code paths unless behind `__DEV__` flag.
+*/
 export declare const isVoidTag: (key: string) => boolean;
 /**
- * Compiler only.
- * Do NOT use in runtime code paths unless behind `__DEV__` flag.
- */
+* Compiler only.
+* Do NOT use in runtime code paths unless behind `__DEV__` flag.
+*/
 export declare const isFormattingTag: (key: string) => boolean;
 /**
- * Compiler only.
- * Do NOT use in runtime code paths unless behind `__DEV__` flag.
- */
+* Compiler only.
+* Do NOT use in runtime code paths unless behind `__DEV__` flag.
+*/
 export declare const isAlwaysCloseTag: (key: string) => boolean;
 /**
- * Compiler only.
- * Do NOT use in runtime code paths unless behind `__DEV__` flag.
- */
+* Compiler only.
+* Do NOT use in runtime code paths unless behind `__DEV__` flag.
+*/
 export declare const isInlineTag: (key: string) => boolean;
 /**
- * Compiler only.
- * Do NOT use in runtime code paths unless behind `__DEV__` flag.
- */
+* Compiler only.
+* Do NOT use in runtime code paths unless behind `__DEV__` flag.
+*/
 export declare const isBlockTag: (key: string) => boolean;
-
+//#endregion
+//#region temp/packages/shared/src/domAttrConfig.d.ts
 export declare const isSpecialBooleanAttr: (key: string) => boolean;
 /**
- * The full list is needed during SSR to produce the correct initial markup.
- */
+* The full list is needed during SSR to produce the correct initial markup.
+*/
 export declare const isBooleanAttr: (key: string) => boolean;
 /**
- * Boolean attributes should be included if the value is truthy or ''.
- * e.g. `<select multiple>` compiles to `{ multiple: '' }`
- */
+* Boolean attributes should be included if the value is truthy or ''.
+* e.g. `<select multiple>` compiles to `{ multiple: '' }`
+*/
 export declare function includeBooleanAttr(value: unknown): boolean;
 export declare function isSSRSafeAttrName(name: string): boolean;
 export declare const propsToAttrMap: Record<string, string | undefined>;
 /**
- * Known attributes, this is used for stringification of runtime static nodes
- * so that we don't stringify bindings that cannot be set from HTML.
- * Don't also forget to allow `data-*` and `aria-*`!
- * Generated from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes
- */
+* Known attributes, this is used for stringification of runtime static nodes
+* so that we don't stringify bindings that cannot be set from HTML.
+* Don't also forget to allow `data-*` and `aria-*`!
+* Generated from https://developer.mozilla.org/en-US/docs/Web/HTML/Attributes
+*/
 export declare const isKnownHtmlAttr: (key: string) => boolean;
 /**
- * Generated from https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute
- */
+* Generated from https://developer.mozilla.org/en-US/docs/Web/SVG/Attribute
+*/
 export declare const isKnownSvgAttr: (key: string) => boolean;
 /**
- * Generated from https://developer.mozilla.org/en-US/docs/Web/MathML/Attribute
- */
+* Generated from https://developer.mozilla.org/en-US/docs/Web/MathML/Attribute
+*/
 export declare const isKnownMathMLAttr: (key: string) => boolean;
 /**
- * Shared between server-renderer and runtime-core hydration logic
- */
+* Shared between server-renderer and runtime-core hydration logic
+*/
 export declare function isRenderableAttrValue(value: unknown): boolean;
 export declare function shouldSetAsAttr(tagName: string, key: string): boolean;
-
+//#endregion
+//#region temp/packages/shared/src/domNamespace.d.ts
 export type Namespace = number;
 export declare enum Namespaces {
-    HTML = 0,
-    SVG = 1,
-    MATH_ML = 2
+  HTML = 0,
+  SVG = 1,
+  MATH_ML = 2
 }
-
+//#endregion
+//#region temp/packages/shared/src/escapeHtml.d.ts
 export declare function escapeHtml(string: unknown): string;
 export declare function escapeHtmlComment(src: string): string;
 export declare const cssVarNameEscapeSymbolsRE: RegExp;
 export declare function getEscapedCssVarName(key: string, doubleEscape: boolean): string;
-
+//#endregion
+//#region temp/packages/shared/src/looseEqual.d.ts
 export declare function looseEqual(a: any, b: any): boolean;
 export declare function looseIndexOf(arr: any[], val: any): number;
-
+//#endregion
+//#region temp/packages/shared/src/toDisplayString.d.ts
 /**
- * For converting {{ interpolation }} values to displayed strings.
- * @private
- */
+* For converting {{ interpolation }} values to displayed strings.
+* @private
+*/
 export declare const toDisplayString: (val: unknown) => string;
-
-export type Prettify<T> = {
-    [K in keyof T]: T[K];
-} & {};
-export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends (k: infer I) => void ? I : never;
-export type LooseRequired<T> = {
-    [P in keyof (T & Required<T>)]: T[P];
-};
+//#endregion
+//#region temp/packages/shared/src/typeUtils.d.ts
+export type Prettify<T> = { [K in keyof T]: T[K] } & {};
+export type UnionToIntersection<U> = (U extends any ? (k: U) => void : never) extends ((k: infer I) => void) ? I : never;
+export type LooseRequired<T> = { [P in keyof (T & Required<T>)]: T[P] };
 export type IfAny<T, Y, N> = 0 extends 1 & T ? Y : N;
 export type IsKeyValues<T, K = string> = IfAny<T, false, T extends object ? (keyof T extends K ? true : false) : false>;
 /**
- * Utility for extracting the parameters from a function overload (for typed emits)
- * https://github.com/microsoft/TypeScript/issues/32164#issuecomment-1146737709
- */
+* Utility for extracting the parameters from a function overload (for typed emits)
+* https://github.com/microsoft/TypeScript/issues/32164#issuecomment-1146737709
+*/
 export type OverloadParameters<T extends (...args: any[]) => any> = Parameters<OverloadUnion<T>>;
 type OverloadProps<TOverload> = Pick<TOverload, keyof TOverload>;
-type OverloadUnionRecursive<TOverload, TPartialOverload = unknown> = TOverload extends (...args: infer TArgs) => infer TReturn ? TPartialOverload extends TOverload ? never : OverloadUnionRecursive<TPartialOverload & TOverload, TPartialOverload & ((...args: TArgs) => TReturn) & OverloadProps<TOverload>> | ((...args: TArgs) => TReturn) : never;
-type OverloadUnion<TOverload extends (...args: any[]) => any> = Exclude<OverloadUnionRecursive<(() => never) & TOverload>, TOverload extends () => never ? never : () => never>;
-
+type OverloadUnionRecursive<TOverload, TPartialOverload = unknown> = TOverload extends ((...args: infer TArgs) => infer TReturn) ? TPartialOverload extends TOverload ? never : OverloadUnionRecursive<TPartialOverload & TOverload, TPartialOverload & ((...args: TArgs) => TReturn) & OverloadProps<TOverload>> | ((...args: TArgs) => TReturn) : never;
+type OverloadUnion<TOverload extends (...args: any[]) => any> = Exclude<OverloadUnionRecursive<(() => never) & TOverload>, TOverload extends (() => never) ? never : () => never>;
+//#endregion
+//#region temp/packages/shared/src/subSequence.d.ts
 export declare function getSequence(arr: number[]): number[];
-
+//#endregion
+//#region temp/packages/shared/src/cssVars.d.ts
 /**
- * Normalize CSS var value created by `v-bind` in `<style>` block
- * See https://github.com/vuejs/core/pull/12461#issuecomment-2495804664
- */
+* Normalize CSS var value created by `v-bind` in `<style>` block
+* See https://github.com/vuejs/core/pull/12461#issuecomment-2495804664
+*/
 export declare function normalizeCssVarValue(value: unknown): string;
-
-
+//#endregion